|
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 |
java.lang.Object
oracle.oud.requests.CompareRequestWrapper
public class CompareRequestWrapper
This class wraps a Compare request.
Constructor Summary | |
---|---|
CompareRequestWrapper(CompareRequest request) Creates a new CompareRequestWrapper that wraps the specified compare request. |
Method Summary | ||
---|---|---|
CompareRequest |
addControl(Control control) Adds the provided control to this request. |
|
ByteString |
getAssertionValue() Returns the assertion value to be compared. |
|
java.lang.String |
getAssertionValueAsString() Returns the assertion value to be compared decoded as a UTF-8 string. |
|
java.lang.Object |
getAttachment(java.lang.String name) Retrieves the attachment with the specified name. |
|
java.util.Set<java.lang.String> |
getAttachmentNames() Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object. |
|
AttributeDescription |
getAttributeDescription() Returns the name of the attribute to be compared. |
|
|
getControl(ControlDecoder<C> decoder) Decodes and returns the first control in this request having an OID corresponding to the provided control decoder. |
|
java.util.List<Control> |
getControls() Returns a List containing the controls included with this request. |
|
DN |
getName() Returns the distinguished name of the entry to be compared. |
|
boolean |
isInternal() Returns true if this request is flagged as internal; false otherwise. |
|
java.lang.Object |
removeAttachment(java.lang.String name) Removes the attachment with the specified name. |
|
Request |
removeControl(Control control) Removes the provided control from this request. |
|
CompareRequest |
setAssertionValue(ByteString value) Sets the assertion value to be compared. |
|
CompareRequest |
setAssertionValue(java.lang.Object value) Sets the assertion value to be compared. |
|
java.lang.Object |
setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment. |
|
CompareRequest |
setAttributeDescription(AttributeDescription attributeDescription) Sets the name of the attribute to be compared. |
|
CompareRequest |
setAttributeDescription(java.lang.String attributeDescription) Sets the name of the attribute to be compared. |
|
CompareRequest |
setName(DN dn) Sets the distinguished name of the entry to be compared. |
|
CompareRequest |
setName(java.lang.String dn) Sets the distinguished name of the entry to be compared. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.oud.requests.Request |
---|
getControl, getControls, isInternal, removeControl |
Methods inherited from interface oracle.oud.plugin.AttachmentHolder |
---|
getAttachment, getAttachmentNames, removeAttachment, setAttachment |
Constructor Detail |
---|
public CompareRequestWrapper(CompareRequest request)
request
- the request to wrap.Method Detail |
---|
public CompareRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
Request
addControl
in interface CompareRequest
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
.public ByteString getAssertionValue()
CompareRequest
getAssertionValue
in interface CompareRequest
public java.lang.String getAssertionValueAsString()
CompareRequest
getAssertionValueAsString
in interface CompareRequest
public AttributeDescription getAttributeDescription()
CompareRequest
getAttributeDescription
in interface CompareRequest
public DN getName()
CompareRequest
getName
in interface CompareRequest
public CompareRequest setAssertionValue(ByteString value) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
CompareRequest
setAssertionValue
in interface CompareRequest
value
- The assertion value to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the assertion value to be set.java.lang.NullPointerException
- If value
was null
.public CompareRequest setAssertionValue(java.lang.Object value) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
CompareRequest
If the assertion value is not an instance of ByteString
then it will be converted using the ByteString.valueOf(Object)
method.
setAssertionValue
in interface CompareRequest
value
- The assertion value to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the assertion value to be set.java.lang.NullPointerException
- If value
was null
.public CompareRequest setAttributeDescription(AttributeDescription attributeDescription) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
CompareRequest
setAttributeDescription
in interface CompareRequest
attributeDescription
- The name of the attribute to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the attribute description to be set.java.lang.NullPointerException
- If attributeDescription
was null
.public CompareRequest setAttributeDescription(java.lang.String attributeDescription) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
CompareRequest
setAttributeDescription
in interface CompareRequest
attributeDescription
- The name of the attribute to be compared.PluginException
- If attributeDescription
could not be decoded.java.lang.UnsupportedOperationException
- If this compare request does not permit the attribute description to be set.java.lang.NullPointerException
- If attributeDescription
was null
.public CompareRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
CompareRequest
setName
in interface CompareRequest
dn
- The distinguished name of the entry to be compared.java.lang.UnsupportedOperationException
- If this compare request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.public CompareRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
CompareRequest
setName
in interface CompareRequest
dn
- The distinguished name of the entry to be compared.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this compare request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.public <C extends Control> C getControl(ControlDecoder<C> decoder) throws java.lang.NullPointerException, PluginException
Request
getControl
in interface Request
C
- The type of control to be decoded and returned.decoder
- The control decoder.null
if the control is not included with this request.java.lang.NullPointerException
- If decoder
was null
.PluginException
- If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).public java.util.List<Control> getControls()
Request
List
containing the controls included with this request. The returned List
is immutable.getControls
in interface Request
List
containing the controls.public Request removeControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
Request
removeControl
in interface Request
control
- The control to be removed from this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be removed.java.lang.NullPointerException
- If control
was null
.public java.lang.Object removeAttachment(java.lang.String name)
AttachmentHolder
removeAttachment
in interface AttachmentHolder
name
- The name for the attachment to remove. It will be treated in a case-sensitive manner.null
if it does not exist.public java.lang.Object setAttachment(java.lang.String name, java.lang.Object value)
AttachmentHolder
setAttachment
in interface AttachmentHolder
name
- The name to use for the attachment.value
- The value to use for the attachment.null
if there was previously no such attachment.public java.lang.Object getAttachment(java.lang.String name)
AttachmentHolder
getAttachment
in interface AttachmentHolder
name
- The name for the attachment to retrieve. It will be treated in a case-sensitive manner.null
if it does not exist.public java.util.Set<java.lang.String> getAttachmentNames()
AttachmentHolder
getAttachmentNames
in interface AttachmentHolder
public boolean isInternal()
Request
true
if this request is flagged as internal; false
otherwise.
When a request is flagged internal, various components of the server may behave in a manner that is less restrictive. For example, attributes defined as NO-USER-MODIFICATION are allowed to be added, private backends are accessible, ...
isInternal
in interface Request
true
if this request is flagged as internal; false
otherwise.
|
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 |