public interface LdapApiService
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_PROTOCOL_CODEC_FACTORY |
Modifier and Type | Method and Description |
---|---|
ExtendedRequestDecorator<?,?> |
decorate(ExtendedRequest<?> decoratedMessage) |
ExtendedResponseDecorator<?> |
decorate(ExtendedResponse decoratedMessage) |
ExtendedRequest<?> |
fromJndi(ExtendedRequest jndiRequest)
Creates a model ExtendedResponse from the JNDI ExtendedResponse.
|
ExtendedResponse |
fromJndi(ExtendedResponse jndiResponse)
Creates a model ExtendedResponse from the JNDI ExtendedResponse.
|
Control |
fromJndiControl(Control jndiControl)
Creates a model control from the JNDI control.
|
org.apache.mina.filter.codec.ProtocolCodecFactory |
getProtocolCodecFactory()
Creates a new LDAP
ProtocolCodecFactory . |
boolean |
isControlRegistered(String oid)
Checks if a control has been registered.
|
boolean |
isExtendedOperationRegistered(String oid)
Checks to see if an extended operation, either a standard request
response, pair or just an unsolicited response is registered.
|
CodecControl<? extends Control> |
newControl(Control control)
Creates a new codec control decorator for the provided control.
|
CodecControl<? extends Control> |
newControl(String oid)
Creates a new codec control decorator of the specified type.
|
ExtendedRequest<?> |
newExtendedRequest(String oid,
byte[] value)
Creates a new ExtendedRequest instance.
|
<E extends ExtendedResponse> |
newExtendedResponse(ExtendedRequest<E> req,
byte[] serializedResponse) |
Asn1Container |
newMessageContainer()
Creates a new MessageContainer.
|
ControlFactory<?,?> |
registerControl(ControlFactory<?,?> factory)
Registers an
ControlFactory with this service. |
Iterator<String> |
registeredControls()
Returns an Iterator over the OID Strings of registered controls.
|
Iterator<String> |
registeredExtendedRequests()
Returns an Iterator over the OID Strings of registered extended
requests.
|
Iterator<String> |
registeredUnsolicitedResponses()
Returns an Iterator over the OID Strings of registered unsolicited
extended responses.
|
ExtendedRequestFactory<?,?> |
registerExtendedRequest(ExtendedRequestFactory<?,?> factory)
Registers an
ExtendedRequestFactory for generating extended request
response pairs. |
org.apache.mina.filter.codec.ProtocolCodecFactory |
registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory factory)
Registers a ProtocolCodecFactory with this LdapCodecService.
|
UnsolicitedResponseFactory<?> |
registerUnsolicitedResponse(UnsolicitedResponseFactory<?> factory)
Registers an
UnsolicitedResponseFactory for generating extended
responses sent by servers without an extended request. |
ExtendedRequest |
toJndi(ExtendedRequest<?> modelRequest)
Creates a JNDI
ExtendedResponse from the model
ExtendedResponse . |
ExtendedResponse |
toJndi(ExtendedResponse modelResponse)
Creates a JNDI
ExtendedResponse from the model
ExtendedResponse . |
Control |
toJndiControl(Control modelControl)
Creates a JNDI control from the ldap model's control.
|
ControlFactory<?,?> |
unregisterControl(String oid)
Unregisters an
ControlFactory with this service. |
ExtendedRequestFactory<?,?> |
unregisterExtendedRequest(String oid)
Unregisters an
ExtendedRequestFactory for generating extended
request response pairs. |
UnsolicitedResponseFactory<?> |
unregisterUnsolicitedResponse(String oid)
Unregisters an
UnsolicitedResponseFactory for generating
extended responses sent by servers without an extended request. |
static final String DEFAULT_PROTOCOL_CODEC_FACTORY
Iterator<String> registeredControls()
boolean isControlRegistered(String oid)
ControlFactory<?,?> registerControl(ControlFactory<?,?> factory)
ControlFactory
with this service.factory
- The control factoryControlFactory<?,?> unregisterControl(String oid)
ControlFactory
with this service.oid
- The oid of the control the factory is associated with.CodecControl<? extends Control> newControl(String oid)
oid
- The OID of the new control to create.CodecControl<? extends Control> newControl(Control control)
control
- The control the codec control is generated for.Control toJndiControl(Control modelControl) throws EncoderException
modelControl
- The model's control.EncoderException
- if there are problems encoding the modelControl.Control fromJndiControl(Control jndiControl) throws DecoderException
jndiControl
- The JNDI control.DecoderException
- if there are problems decoding the value of the JNDI control.Iterator<String> registeredExtendedRequests()
ExtendedRequestFactory<?,?> registerExtendedRequest(ExtendedRequestFactory<?,?> factory)
ExtendedRequestFactory
for generating extended request
response pairs.factory
- The extended request factoryExtendedRequestFactory<?,?> unregisterExtendedRequest(String oid)
ExtendedRequestFactory
for generating extended
request response pairs.oid
- The extended request oidboolean isExtendedOperationRegistered(String oid)
oid
- The object identifier for the extended operationIterator<String> registeredUnsolicitedResponses()
UnsolicitedResponseFactory<?> registerUnsolicitedResponse(UnsolicitedResponseFactory<?> factory)
UnsolicitedResponseFactory
for generating extended
responses sent by servers without an extended request.factory
- The unsolicited response creating factoryUnsolicitedResponseFactory<?> unregisterUnsolicitedResponse(String oid)
UnsolicitedResponseFactory
for generating
extended responses sent by servers without an extended request.oid
- The unsolicited response oidExtendedResponse fromJndi(ExtendedResponse jndiResponse) throws DecoderException
jndiResponse
- The JNDI ExtendedResponseDecoderException
- if the response value cannot be decoded.ExtendedResponse toJndi(ExtendedResponse modelResponse) throws EncoderException
ExtendedResponse
from the model
ExtendedResponse
.modelResponse
- EncoderException
ExtendedRequest<?> fromJndi(ExtendedRequest jndiRequest) throws DecoderException
jndiResponse
- The JNDI ExtendedResponseDecoderException
- if the response value cannot be decoded.ExtendedRequest toJndi(ExtendedRequest<?> modelRequest) throws EncoderException
ExtendedResponse
from the model
ExtendedResponse
.modelResponse
- EncoderException
org.apache.mina.filter.codec.ProtocolCodecFactory getProtocolCodecFactory()
ProtocolCodecFactory
.ProtocolCodecFactory
org.apache.mina.filter.codec.ProtocolCodecFactory registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory factory)
factory
- The factory being registered.ProtocolCodecFactory
, or null if
none had been set earlier.Asn1Container newMessageContainer()
<E extends ExtendedResponse> E newExtendedResponse(ExtendedRequest<E> req, byte[] serializedResponse) throws DecoderException
DecoderException
ExtendedRequest<?> newExtendedRequest(String oid, byte[] value)
oid
- the extended request's object identifiervalue
- the encoded value of the extended requestExtendedRequestDecorator<?,?> decorate(ExtendedRequest<?> decoratedMessage)
ExtendedResponseDecorator<?> decorate(ExtendedResponse decoratedMessage)
Copyright © 2003-2014 The Apache Software Foundation. All Rights Reserved.