|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.SASLOption
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SASLOption
This class provides a data structure that holds information about an option that can be used in the course of SASL authentication.
Constructor Summary | |
---|---|
SASLOption(java.lang.String name,
java.lang.String description,
boolean isRequired,
boolean isMultiValued)
Creates a new SASL option with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Retrieves a description for this SASL option. |
java.lang.String |
getName()
Retrieves the name for this SASL option. |
boolean |
isMultiValued()
Indicates whether this SASL option may be provided multiple times when trying to bind with the associated mechanism. |
boolean |
isRequired()
Indicates whether this SASL option must be provided when attempting to bind with the associated mechanism. |
java.lang.String |
toString()
Retrieves a string representation for this SASL option. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this SASL option to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SASLOption(java.lang.String name, java.lang.String description, boolean isRequired, boolean isMultiValued)
name
- The name for this SASL option.description
- A description for this SASL option.isRequired
- Indicates whether this option is required for use in
conjunction with the associated SASL mechanism.isMultiValued
- Indicates whether this option is allowed to be
specified multiple times for a single bind request.Method Detail |
---|
public java.lang.String getName()
public java.lang.String getDescription()
public boolean isRequired()
true
if this SASL option must be specified when trying to
bind with the associated mechanism, or false
if not.public boolean isMultiValued()
true
if this SASL option may be provided multiple times
when trying to bind with the associated mechanism, or
false
if not.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 |