javax.management.remote
Interface 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 JMXConnectorServer.AUTHENTICATOR sample code for javax.management.remote.JMXConnectorServer.AUTHENTICATOR definition code for javax.management.remote.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 subject sample code for javax.security.auth.Subject definition code for javax.security.auth.Subject filled in with its associated principals sample code for java.security.Principal definition code for java.security.Principal is returned. Authorization checks will be then performed based on the given set of principals.

Since:
1.5

Method Summary
 Subject sample code for javax.security.auth.Subject definition code for javax.security.auth.Subject authenticate sample code for javax.management.remote.JMXAuthenticator.authenticate(java.lang.Object) definition code for javax.management.remote.JMXAuthenticator.authenticate(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  credentials)
          Authenticates the MBeanServerConnection client with the given client credentials.
 

Method Detail

authenticate sample code for javax.management.remote.JMXAuthenticator.authenticate(java.lang.Object) definition code for javax.management.remote.JMXAuthenticator.authenticate(java.lang.Object)

Subject sample code for javax.security.auth.Subject definition code for javax.security.auth.Subject  authenticate(Object sample code for java.lang.Object definition code for java.lang.Object  credentials)

Authenticates the MBeanServerConnection client with the given client credentials.

Parameters:
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.
Returns:
the authenticated subject containing its associated principals.
Throws:
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if the server cannot authenticate the user with the provided credentials.