FileDocCategorySizeDatePackage
JMXAuthenticator.javaAPI DocJava SE 5 API2000Fri Aug 26 14:57:38 BST 2005javax.management.remote

JMXAuthenticator

public interface JMXAuthenticator

Interface to define how remote credentials are converted into a JAAS Subject. This interface is used by the RMI Connector Server, and can be used by other connector servers.

The user-defined authenticator instance is passed to the connector server in the environment map as the value of the attribute {@link JMXConnectorServer#AUTHENTICATOR}. For connector servers that use only this authentication system, if this attribute is not present or its value is null then no user authentication will be performed and full access to the methods exported by the MBeanServerConnection object will be allowed.

If authentication is successful then an authenticated {@link Subject subject} filled in with its associated {@link Principal principals} is returned. Authorization checks will be then performed based on the given set of principals.

since
1.5
since.unbundled
1.0

Fields Summary
Constructors Summary
Methods Summary
public javax.security.auth.Subjectauthenticate(java.lang.Object credentials)

Authenticates the MBeanServerConnection client with the given client credentials.

param
credentials the user-defined credentials to be passed into the server in order to authenticate the user before creating the MBeanServerConnection. The actual type of this parameter, and whether it can be null, depends on the connector.
return
the authenticated subject containing its associated principals.
exception
SecurityException if the server cannot authenticate the user with the provided credentials.