|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.SASLMechanismInfo
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SASLMechanismInfo
This class provides a data structure which holds information about a SASL
mechanism supported for use with the SASLUtils
class.
Constructor Summary | |
---|---|
SASLMechanismInfo(java.lang.String name,
java.lang.String description,
boolean acceptsPassword,
boolean requiresPassword,
SASLOption... options)
Creates a new SASL mechanism info object with the provided information. |
Method Summary | |
---|---|
boolean |
acceptsPassword()
Indicates whether the SASL mechanism accepts a password for authentication processing. |
java.lang.String |
getDescription()
Retrieves a description for the SASL mechanism. |
java.lang.String |
getName()
Retrieves the name of the SASL mechanism. |
java.util.List<SASLOption> |
getOptions()
Retrieves a list of the options that may be used with the SASL mechanism. |
boolean |
requiresPassword()
Indicates whether the SASL mechanism requires a password for authentication processing. |
java.lang.String |
toString()
Retrieves a string representation of this SASL mechanism info object. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this SASL mechanism info object to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SASLMechanismInfo(java.lang.String name, java.lang.String description, boolean acceptsPassword, boolean requiresPassword, SASLOption... options)
name
- The name for the SASL mechanism.description
- A description for the SASL mechanism.acceptsPassword
- Indicates whether the SASL mechanism allows a
password to be provided.requiresPassword
- Indicates whether the SASL mechanism requires a
password to be provided.options
- The set of options that are associated with the
SASL mechanism.Method Detail |
---|
public java.lang.String getName()
public java.lang.String getDescription()
public boolean acceptsPassword()
true
if the SASL mechanism accepts a password for
authentication processing, or false
if not.public boolean requiresPassword()
true
if the SASL mechanism requires a password for
authentication processing, or false
if not.public java.util.List<SASLOption> getOptions()
public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |