OpenJDK 1.23 · com.sun.security.sasl.gsskerb.FactoryImpl

Modifier and Type	Field and Description
private static final int	GSS_KERB_V5
private static final int[]	mechPolicies
private static final String[]	myMechs

Access	Constructor and Description
public	FactoryImpl()

Method Summary

Modifier and Type	Method and Description
public SaslClient	createSaslClient(String[] The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). mechs, String The possibly null protocol-dependent identification to be used for authorization. If null or empty, the server derives an authorization ID from the client's authentication credentials. When the SASL authentication completes successfully, the specified entity is granted access. authorizationId, String The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap"). protocol, String The non-null fully qualified host name of the server to authenticate to. serverName, Map<String, ?> The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the `Sasl` class for a list of standard properties. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys. props, CallbackHandler The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a `NameCallback`. The password is requested by using a `PasswordCallback`. The realm is requested by using a `RealmChoiceCallback` if there is a list of realms to choose from, and by using a `RealmCallback` if the realm must be entered. cbh) Implements javax.security.sasl.SaslClientFactory.createSaslClient. Creates a SaslClient using the parameters supplied.
public SaslServer	createSaslServer(String The non-null IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). mech, String The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap"). protocol, String The fully qualified host name of the server to authenticate to, or null if the server is not bound to any specific host name. If the mechanism does not allow an unbound server, a `SaslException` will be thrown. serverName, Map<String, ?> The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the `Sasl` class for a list of standard properties. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys. props, CallbackHandler The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a `NameCallback`. The password is requested by using a `PasswordCallback`. The realm is requested by using a `RealmChoiceCallback` if there is a list of realms to choose from, and by using a `RealmCallback` if the realm must be entered. cbh) Implements javax.security.sasl.SaslServerFactory.createSaslServer. Creates a `SaslServer` using the parameters supplied.
public String[]	getMechanismNames(Map<String, ?> The possibly null set of properties used to specify the security policy of the SASL mechanisms. For example, if `props` contains the `Sasl.POLICY_NOPLAINTEXT` property with the value `"true"`, then the factory must not return any SASL mechanisms that are susceptible to simple plain passive attacks. See the `Sasl` class for a complete list of policy properties. Non-policy related properties, if present in `props`, are ignored, including any map entries with non-String keys. props) Implements javax.security.sasl.SaslClientFactory.getMechanismNames, javax.security.sasl.SaslServerFactory.getMechanismNames. Returns an array of names of mechanisms that match the specified mechanism selection policies.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

GSS_KERB_V5	back to summary
private static final int GSS_KERB_V5

mechPolicies	back to summary
private static final int[] mechPolicies

myMechs	back to summary
private static final String[] myMechs

FactoryImpl	back to summary
public FactoryImpl()

Method Detail

createSaslClient back to summary

createSaslClient	back to summary
public SaslClient createSaslClient(String[] mechs, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException Implements javax.security.sasl.SaslClientFactory.createSaslClient. Doc from javax.security.sasl.SaslClientFactory.createSaslClient. Creates a SaslClient using the parameters supplied. Parameters mechs:String[] The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). authorizationId:String The possibly null protocol-dependent identification to be used for authorization. If null or empty, the server derives an authorization ID from the client's authentication credentials. When the SASL authentication completes successfully, the specified entity is granted access. protocol:String The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap"). serverName:String The non-null fully qualified host name of the server to authenticate to. props:Map<String, ?> The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the `Sasl` class for a list of standard properties. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys. cbh:CallbackHandler The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a `NameCallback`. The password is requested by using a `PasswordCallback`. The realm is requested by using a `RealmChoiceCallback` if there is a list of realms to choose from, and by using a `RealmCallback` if the realm must be entered. Returns:SaslClient A possibly null `SaslClient` created using the parameters supplied. If null, this factory cannot produce a `SaslClient` using the parameters supplied. Exceptions SaslException: If cannot create a `SaslClient` because of an error.

public SaslClient createSaslClient(String[] mechs, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException

Implements javax.security.sasl.SaslClientFactory.createSaslClient.

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

Creates a SaslClient using the parameters supplied.

Parameters

mechs:String[]: The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
authorizationId:String: The possibly null protocol-dependent identification to be used for authorization. If null or empty, the server derives an authorization ID from the client's authentication credentials. When the SASL authentication completes successfully, the specified entity is granted access.
protocol:String: The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").
serverName:String: The non-null fully qualified host name of the server to authenticate to.
props:Map<String, ?>: The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the Sasl class for a list of standard properties. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys.
cbh:CallbackHandler: The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a NameCallback. The password is requested by using a PasswordCallback. The realm is requested by using a RealmChoiceCallback if there is a list of realms to choose from, and by using a RealmCallback if the realm must be entered.

Returns:SaslClient

A possibly null SaslClient created using the parameters supplied. If null, this factory cannot produce a SaslClient using the parameters supplied.

Exceptions

SaslException:: If cannot create a SaslClient because of an error.

createSaslServer back to summary

createSaslServer	back to summary
public SaslServer createSaslServer(String mech, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException Implements javax.security.sasl.SaslServerFactory.createSaslServer. Doc from javax.security.sasl.SaslServerFactory.createSaslServer. Creates a `SaslServer` using the parameters supplied. It returns null if no `SaslServer` can be created using the parameters supplied. Throws `SaslException` if it cannot create a `SaslServer` because of an error. Parameters mech:String The non-null IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). protocol:String The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap"). serverName:String The fully qualified host name of the server to authenticate to, or null if the server is not bound to any specific host name. If the mechanism does not allow an unbound server, a `SaslException` will be thrown. props:Map<String, ?> The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the `Sasl` class for a list of standard properties. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys. cbh:CallbackHandler The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a `NameCallback`. The password is requested by using a `PasswordCallback`. The realm is requested by using a `RealmChoiceCallback` if there is a list of realms to choose from, and by using a `RealmCallback` if the realm must be entered. Returns:SaslServer A possibly null `SaslServer` created using the parameters supplied. If null, this factory cannot produce a `SaslServer` using the parameters supplied. Exceptions SaslException: If cannot create a `SaslServer` because of an error.

public SaslServer createSaslServer(String mech, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException

Implements javax.security.sasl.SaslServerFactory.createSaslServer.

Doc from javax.security.sasl.SaslServerFactory.createSaslServer.

Creates a SaslServer using the parameters supplied. It returns null if no SaslServer can be created using the parameters supplied. Throws SaslException if it cannot create a SaslServer because of an error.

Parameters

mech:String: The non-null IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
protocol:String: The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").
serverName:String: The fully qualified host name of the server to authenticate to, or null if the server is not bound to any specific host name. If the mechanism does not allow an unbound server, a SaslException will be thrown.
props:Map<String, ?>: The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the Sasl class for a list of standard properties. Other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys.
cbh:CallbackHandler: The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a NameCallback. The password is requested by using a PasswordCallback. The realm is requested by using a RealmChoiceCallback if there is a list of realms to choose from, and by using a RealmCallback if the realm must be entered.

Returns:SaslServer

A possibly null SaslServer created using the parameters supplied. If null, this factory cannot produce a SaslServer using the parameters supplied.

Exceptions

SaslException:: If cannot create a SaslServer because of an error.

getMechanismNames back to summary

getMechanismNames	back to summary
public String[] getMechanismNames(Map<String, ?> props) Implements javax.security.sasl.SaslClientFactory.getMechanismNames, javax.security.sasl.SaslServerFactory.getMechanismNames. Doc from javax.security.sasl.SaslClientFactory.getMechanismNames. Returns an array of names of mechanisms that match the specified mechanism selection policies. Parameters props:Map<String, ?> The possibly null set of properties used to specify the security policy of the SASL mechanisms. For example, if `props` contains the `Sasl.POLICY_NOPLAINTEXT` property with the value `"true"`, then the factory must not return any SASL mechanisms that are susceptible to simple plain passive attacks. See the `Sasl` class for a complete list of policy properties. Non-policy related properties, if present in `props`, are ignored, including any map entries with non-String keys. Returns:String[] A non-null array containing a IANA-registered SASL mechanism names.

public String[] getMechanismNames(Map<String, ?> props)

Implements javax.security.sasl.SaslClientFactory.getMechanismNames, javax.security.sasl.SaslServerFactory.getMechanismNames.

Doc from javax.security.sasl.SaslClientFactory.getMechanismNames.

Returns an array of names of mechanisms that match the specified mechanism selection policies.

Parameters

props:Map<String, ?>: The possibly null set of properties used to specify the security policy of the SASL mechanisms. For example, if props contains the Sasl.POLICY_NOPLAINTEXT property with the value "true", then the factory must not return any SASL mechanisms that are susceptible to simple plain passive attacks. See the Sasl class for a complete list of policy properties. Non-policy related properties, if present in props, are ignored, including any map entries with non-String keys.

Returns:String[]

A non-null array containing a IANA-registered SASL mechanism names.

public final Class FactoryImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail