public class DefaultLdapCodecService extends Object implements LdapApiService
LdapApiService
implementation.DEFAULT_PROTOCOL_CODEC_FACTORY
Constructor and Description |
---|
DefaultLdapCodecService()
Creates a new instance of DefaultLdapCodecService.
|
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 control)
Creates a model control from the JNDI control.
|
Map<String,ControlFactory<? extends Control>> |
getControlFactories() |
Map<String,ExtendedOperationFactory> |
getExtendedOperationsFactories() |
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(String responseName,
int messageId,
byte[] serializedResponse)
Create an instance of a ExtendedResponse, knowing its OID.
|
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.
|
ExtendedOperationFactory |
registerExtendedRequest(ExtendedOperationFactory factory)
Registers an
ExtendedOperationFactory for generating extended request
response pairs. |
org.apache.mina.filter.codec.ProtocolCodecFactory |
registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)
Registers a ProtocolCodecFactory with this LdapCodecService.
|
void |
setControlFactories(Map<String,ControlFactory<? extends Control>> controlFactories) |
void |
setExtendedOperationsFactories(Map<String,ExtendedOperationFactory> extendedOperationsFactories) |
void |
setProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory) |
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 control)
Creates a JNDI control from the ldap model's control.
|
ControlFactory<?> |
unregisterControl(String oid)
Unregisters an
ControlFactory with this service. |
ExtendedOperationFactory |
unregisterExtendedRequest(String oid)
Unregisters an
ExtendedOperationFactory for generating extended
request response pairs. |
public DefaultLdapCodecService()
public ControlFactory<?> registerControl(ControlFactory<?> factory)
ControlFactory
with this service.registerControl
in interface LdapApiService
factory
- The control factorypublic ControlFactory<?> unregisterControl(String oid)
ControlFactory
with this service.unregisterControl
in interface LdapApiService
oid
- The oid of the control the factory is associated with.public Iterator<String> registeredControls()
registeredControls
in interface LdapApiService
public boolean isControlRegistered(String oid)
isControlRegistered
in interface LdapApiService
public Iterator<String> registeredExtendedRequests()
registeredExtendedRequests
in interface LdapApiService
public ExtendedOperationFactory registerExtendedRequest(ExtendedOperationFactory factory)
ExtendedOperationFactory
for generating extended request
response pairs.registerExtendedRequest
in interface LdapApiService
factory
- The extended request factorypublic org.apache.mina.filter.codec.ProtocolCodecFactory getProtocolCodecFactory()
ProtocolCodecFactory
.getProtocolCodecFactory
in interface LdapApiService
ProtocolCodecFactory
public org.apache.mina.filter.codec.ProtocolCodecFactory registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)
LdapApiService
registerProtocolCodecFactory
in interface LdapApiService
protocolCodecFactory
- The factory being registered.ProtocolCodecFactory
, or null if
none had been set earlier.public CodecControl<? extends Control> newControl(String oid)
newControl
in interface LdapApiService
oid
- The OID of the new control to create.public CodecControl<? extends Control> newControl(Control control)
newControl
in interface LdapApiService
control
- The control the codec control is generated for.public Control toJndiControl(Control control) throws EncoderException
toJndiControl
in interface LdapApiService
control
- The model's control.EncoderException
- if there are problems encoding the modelControl.public Control fromJndiControl(Control control) throws DecoderException
fromJndiControl
in interface LdapApiService
control
- The JNDI control.DecoderException
- if there are problems decoding the value of the JNDI control.public Asn1Container newMessageContainer()
newMessageContainer
in interface LdapApiService
public ExtendedOperationFactory unregisterExtendedRequest(String oid)
ExtendedOperationFactory
for generating extended
request response pairs.unregisterExtendedRequest
in interface LdapApiService
oid
- The extended request oidpublic ExtendedResponse toJndi(ExtendedResponse modelResponse) throws EncoderException
ExtendedResponse
from the model
ExtendedResponse
.toJndi
in interface LdapApiService
EncoderException
public ExtendedResponse fromJndi(ExtendedResponse jndiResponse) throws DecoderException
fromJndi
in interface LdapApiService
jndiResponse
- The JNDI ExtendedResponseDecoderException
- if the response value cannot be decoded.public ExtendedRequest fromJndi(ExtendedRequest jndiRequest) throws DecoderException
fromJndi
in interface LdapApiService
DecoderException
- if the response value cannot be decoded.public ExtendedRequest toJndi(ExtendedRequest modelRequest) throws EncoderException
ExtendedResponse
from the model
ExtendedResponse
.toJndi
in interface LdapApiService
EncoderException
public <E extends ExtendedResponse> E newExtendedResponse(String responseName, int messageId, byte[] serializedResponse) throws DecoderException
newExtendedResponse
in interface LdapApiService
responseName
- The extendedRespose OIDmessageId
- The original message IDserializedResponse
- The serialized response payloadDecoderException
public ExtendedRequest newExtendedRequest(String oid, byte[] value)
newExtendedRequest
in interface LdapApiService
oid
- the extended request's object identifiervalue
- the encoded value of the extended requestpublic ExtendedRequestDecorator<?> decorate(ExtendedRequest decoratedMessage)
decorate
in interface LdapApiService
public ExtendedResponseDecorator<?> decorate(ExtendedResponse decoratedMessage)
decorate
in interface LdapApiService
public boolean isExtendedOperationRegistered(String oid)
isExtendedOperationRegistered
in interface LdapApiService
oid
- The object identifier for the extended operationpublic Map<String,ControlFactory<? extends Control>> getControlFactories()
public void setControlFactories(Map<String,ControlFactory<? extends Control>> controlFactories)
controlFactories
- the controlFactories to setpublic Map<String,ExtendedOperationFactory> getExtendedOperationsFactories()
public void setExtendedOperationsFactories(Map<String,ExtendedOperationFactory> extendedOperationsFactories)
extendedOperationsFactories
- the extendedOperationsFactories to setpublic void setProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)
protocolCodecFactory
- the protocolCodecFactory to setCopyright © 2003–2015 The Apache Software Foundation. All rights reserved.