Class Overview
Client/server factory for GSSAPI (Kerberos V5) SASL client/server mechs.
See GssKrb5Client/GssKrb5Server for input requirements.
Summary
Public Methods |
SaslClient
|
createSaslClient(String[] mechs, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)
Creates a SaslClient using the parameters supplied.
|
SaslServer
|
createSaslServer(String mech, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh)
Creates a SaslServer using the parameters supplied.
|
String[]
|
getMechanismNames(Map<String, ?> props)
Returns an array of names of mechanisms that match the specified
mechanism selection policies.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
From interface
javax.security.sasl.SaslClientFactory
|
From interface
javax.security.sasl.SaslServerFactory
|
Public Constructors
Public Methods
Creates a SaslClient using the parameters supplied.
Parameters
mechs
| 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
| 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
| The non-null string name of the protocol for which
the authentication is being performed (e.g., "ldap"). |
serverName
| The non-null fully qualified host name
of the server to authenticate to. |
props
| 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
| 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
- A possibly null SaslClient created using the parameters
supplied. If null, this factory cannot produce a SaslClient
using the parameters supplied.
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
| The non-null
IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5"). |
protocol
| The non-null string name of the protocol for which
the authentication is being performed (e.g., "ldap"). |
serverName
| The non-null fully qualified host name of the server
to authenticate to. |
props
| 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
| 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
- A possibly null SaslServer created using the parameters
supplied. If null, this factory cannot produce a SaslServer
using the parameters supplied.
public
String[]
getMechanismNames
(Map<String, ?> props)
Returns an array of names of mechanisms that match the specified
mechanism selection policies.
Parameters
props
| 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
- A non-null array containing a IANA-registered SASL mechanism names.