|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BindRequest
The Bind operation allows authentication information to be exchanged between the client and server. The Bind operation should be thought of as the "authenticate" operation.
Creation of Bind requests is provided by newBindRequest(DN, ByteString)
and newBindRequest(String, char[])
Method Summary | |
---|---|
BindRequest |
addControl(Control control) Adds the provided control to this request. |
byte |
getAuthenticationType() Returns the authentication mechanism identifier for this generic bind request as defined by the LDAP protocol. |
DN |
getName() Returns the name of the Directory object that the client wishes to bind as. |
ByteString |
getPassword() Returns the password of the Directory object that the client wishes to bind as. |
BindRequest |
setName(DN dn) Sets the name of the Directory object that the client wishes to bind as. |
BindRequest |
setName(java.lang.String dn) Sets the name of the Directory object that the client wishes to bind as. |
BindRequest |
setPassword(ByteString password) Sets the password of the Directory object that the client wishes to bind as. |
BindRequest |
setPassword(char[] password) Sets the password of the Directory object that the client wishes to bind as. |
Methods inherited from interface oracle.oud.requests.Request |
---|
getControl, getControls, isInternal, removeControl |
Methods inherited from interface oracle.oud.plugin.AttachmentHolder |
---|
getAttachment, getAttachmentNames, removeAttachment, setAttachment |
Method Detail |
---|
BindRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
addControl
in interface Request
control
- The control to be added to this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.byte getAuthenticationType()
0x80
is reserved for simple authentication and 0xA3
is reserved for SASL authentication.ByteString getPassword()
null
) when used for of anonymous or unauthenticated binds.DN getName()
null
) when used for of anonymous binds.BindRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
null
when used for of anonymous binds.dn
- The name of the Directory object that the client wishes to bind as.java.lang.UnsupportedOperationException
- If this bind request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.BindRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
null
when used for of anonymous binds.dn
- The name of the Directory object that the client wishes to bind as.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this bind request does not permit the distinguished name to be set.java.lang.NullPointerException
- If name
was null
.BindRequest setPassword(ByteString password) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
null
) when used for of anonymous or unauthenticated binds.password
- The password of the Directory object that the client wishes to bind as, which may be empty.java.lang.UnsupportedOperationException
- If this simple bind request does not permit the password to be set.java.lang.NullPointerException
- If password
was null
.BindRequest setPassword(char[] password) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
null
) when used for of anonymous or unauthenticated binds. Subsequent modifications to the password
array will not alter this bind request.password
- The password of the Directory object that the client wishes to bind as, which may be empty.java.lang.UnsupportedOperationException
- If this simple bind request does not permit the password to be set.java.lang.NullPointerException
- If password
was null
.
|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |