Interface LdapApiService
-
- All Known Implementing Classes:
DefaultLdapCodecService
,StandaloneLdapApiService
public interface LdapApiService
The service interface for the LDAP codec. It gathers all the supported controls and extended operations.- Version:
- $Rev$, $Date$
- Author:
- Apache Directory Project
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_PROTOCOL_CODEC_FACTORY
The default codec factory
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ExtendedRequestDecorator<?>
decorate(ExtendedRequest decoratedMessage)
Decorates an extended request message, ie encapsulate it into a class that do the encoding/decodingExtendedResponseDecorator<?>
decorate(ExtendedResponse decoratedMessage)
Decorates an extended response message, ie encapsulate it into a class that do the encoding/decodingIntermediateResponseDecorator<?>
decorate(IntermediateResponse decoratedMessage)
Decorates an intermediate response message, ie encapsulate it into a class that do the encoding/decodingExtendedRequest
fromJndi(ExtendedRequest jndiRequest)
Creates a model ExtendedResponse from the JNDI ExtendedRequest.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 LDAPProtocolCodecFactory
.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.boolean
isIntermediateResponseRegistered(String oid)
Checks to see if an intermediate response is registered.CodecControl<? extends Control>
newControl(String oid)
Creates a new codec control decorator of the specified type.CodecControl<? extends Control>
newControl(Control control)
Creates a new codec control decorator for the provided control.ExtendedRequest
newExtendedRequest(String oid, byte[] value)
Creates a new ExtendedRequest instance.<E extends ExtendedResponse>
EnewExtendedResponse(String responseName, int messageId, byte[] serializedResponse)
Create an instance of a ExtendedResponse, knowing its OID.<I extends IntermediateResponse>
InewIntermediateResponse(String responseName, int messageId, byte[] serializedResponse)
Create an instance of a IntermediateResponse, knowing its OID.Asn1Container
newMessageContainer()
Creates a new MessageContainer.ControlFactory<?>
registerControl(ControlFactory<?> factory)
Registers anControlFactory
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>
registeredIntermediateResponses()
Returns an Iterator over the OID Strings of registered intermediate responses.ExtendedOperationFactory
registerExtendedRequest(ExtendedOperationFactory factory)
Registers anExtendedOperationFactory
for generating extended request response pairs.IntermediateResponseFactory
registerIntermediateResponse(IntermediateResponseFactory factory)
Registers anIntermediateResponseFactory
for generating intermediate responseorg.apache.mina.filter.codec.ProtocolCodecFactory
registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory factory)
Registers a ProtocolCodecFactory with this LdapCodecService.ExtendedRequest
toJndi(ExtendedRequest modelRequest)
Creates a JNDIExtendedRequest
from the modelExtendedRequest
.ExtendedResponse
toJndi(ExtendedResponse modelResponse)
Creates a JNDIExtendedResponse
from the modelExtendedResponse
.Control
toJndiControl(Control modelControl)
Creates a JNDI control from the ldap model's control.ControlFactory<?>
unregisterControl(String oid)
Unregisters anControlFactory
with this service.ExtendedOperationFactory
unregisterExtendedRequest(String oid)
Unregisters anExtendedOperationFactory
for generating extended request response pairs.IntermediateResponseFactory
unregisterIntermediateResponse(String oid)
Unregisters anIntermediateResponseFactory
for generating intermediate response
-
-
-
Field Detail
-
DEFAULT_PROTOCOL_CODEC_FACTORY
static final String DEFAULT_PROTOCOL_CODEC_FACTORY
The default codec factory- See Also:
- Constant Field Values
-
-
Method Detail
-
registeredControls
Iterator<String> registeredControls()
Returns an Iterator over the OID Strings of registered controls.- Returns:
- The registered control OID Strings
-
isControlRegistered
boolean isControlRegistered(String oid)
Checks if a control has been registered.- Parameters:
oid
- The Control OID we are looking for- Returns:
- The OID of the control to check for registration
-
registerControl
ControlFactory<?> registerControl(ControlFactory<?> factory)
Registers anControlFactory
with this service.- Parameters:
factory
- The control factory- Returns:
- The registred control factory
-
unregisterControl
ControlFactory<?> unregisterControl(String oid)
Unregisters anControlFactory
with this service.- Parameters:
oid
- The oid of the control the factory is associated with.- Returns:
- The unregistred control factory
-
newControl
CodecControl<? extends Control> newControl(String oid)
Creates a new codec control decorator of the specified type.- Parameters:
oid
- The OID of the new control to create.- Returns:
- The newly created codec control.
-
newControl
CodecControl<? extends Control> newControl(Control control)
Creates a new codec control decorator for the provided control.- Parameters:
control
- The control the codec control is generated for.- Returns:
- The newly created codec control.
-
toJndiControl
Control toJndiControl(Control modelControl) throws EncoderException
Creates a JNDI control from the ldap model's control.- Parameters:
modelControl
- The model's control.- Returns:
- The JNDI control.
- Throws:
EncoderException
- if there are problems encoding the modelControl.
-
fromJndiControl
Control fromJndiControl(Control jndiControl) throws DecoderException
Creates a model control from the JNDI control.- Parameters:
jndiControl
- The JNDI control.- Returns:
- The model control.
- Throws:
DecoderException
- if there are problems decoding the value of the JNDI control.
-
registeredExtendedRequests
Iterator<String> registeredExtendedRequests()
Returns an Iterator over the OID Strings of registered extended requests.- Returns:
- The registered extended request OID Strings
-
registerExtendedRequest
ExtendedOperationFactory registerExtendedRequest(ExtendedOperationFactory factory)
Registers anExtendedOperationFactory
for generating extended request response pairs.- Parameters:
factory
- The extended request factory- Returns:
- The displaced factory if one existed for the oid
-
unregisterExtendedRequest
ExtendedOperationFactory unregisterExtendedRequest(String oid)
Unregisters anExtendedOperationFactory
for generating extended request response pairs.- Parameters:
oid
- The extended request oid- Returns:
- The displaced factory if one existed for the oid
-
isExtendedOperationRegistered
boolean isExtendedOperationRegistered(String oid)
Checks to see if an extended operation, either a standard request response, pair or just an unsolicited response is registered.- Parameters:
oid
- The object identifier for the extended operation- Returns:
- true if registered, false if not
-
registeredIntermediateResponses
Iterator<String> registeredIntermediateResponses()
Returns an Iterator over the OID Strings of registered intermediate responses.- Returns:
- The registered Intermediate response OID Strings
-
registerIntermediateResponse
IntermediateResponseFactory registerIntermediateResponse(IntermediateResponseFactory factory)
Registers anIntermediateResponseFactory
for generating intermediate response- Parameters:
factory
- The intermediate response factory- Returns:
- The displaced factory if one existed for the oid
-
unregisterIntermediateResponse
IntermediateResponseFactory unregisterIntermediateResponse(String oid)
Unregisters anIntermediateResponseFactory
for generating intermediate response- Parameters:
oid
- The intermediate response oid- Returns:
- The displaced factory if one existed for the oid
-
isIntermediateResponseRegistered
boolean isIntermediateResponseRegistered(String oid)
Checks to see if an intermediate response is registered.- Parameters:
oid
- The object identifier for the intermediate response- Returns:
- true if registered, false if not
-
fromJndi
ExtendedResponse fromJndi(ExtendedResponse jndiResponse) throws DecoderException
Creates a model ExtendedResponse from the JNDI ExtendedResponse.- Parameters:
jndiResponse
- The JNDI ExtendedResponse- Returns:
- The model ExtendedResponse
- Throws:
DecoderException
- if the response value cannot be decoded.
-
toJndi
ExtendedResponse toJndi(ExtendedResponse modelResponse) throws EncoderException
Creates a JNDIExtendedResponse
from the modelExtendedResponse
.- Parameters:
modelResponse
- The extended response to convert- Returns:
- A JNDI extended response
- Throws:
EncoderException
- If the conversion failed
-
fromJndi
ExtendedRequest fromJndi(ExtendedRequest jndiRequest) throws DecoderException
Creates a model ExtendedResponse from the JNDI ExtendedRequest.- Parameters:
jndiRequest
- The JNDI ExtendedRequest- Returns:
- The model ExtendedRequest
- Throws:
DecoderException
- if the request value cannot be decoded.
-
toJndi
ExtendedRequest toJndi(ExtendedRequest modelRequest) throws EncoderException
Creates a JNDIExtendedRequest
from the modelExtendedRequest
.- Parameters:
modelRequest
- The extended request to convert- Returns:
- A JNDI extended request
- Throws:
EncoderException
- If the conversion failed
-
getProtocolCodecFactory
org.apache.mina.filter.codec.ProtocolCodecFactory getProtocolCodecFactory()
Creates a new LDAPProtocolCodecFactory
.- Returns:
- the
ProtocolCodecFactory
-
registerProtocolCodecFactory
org.apache.mina.filter.codec.ProtocolCodecFactory registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory factory)
Registers a ProtocolCodecFactory with this LdapCodecService.- Parameters:
factory
- The factory being registered.- Returns:
- The previously set
ProtocolCodecFactory
, or null if none had been set earlier.
-
newMessageContainer
Asn1Container newMessageContainer()
Creates a new MessageContainer.- Returns:
- The newly created LDAP MessageContainer instance.
-
newExtendedResponse
<E extends ExtendedResponse> E newExtendedResponse(String responseName, int messageId, byte[] serializedResponse) throws DecoderException
Create an instance of a ExtendedResponse, knowing its OID. Inject the payload into it.- Type Parameters:
E
- The extended response type- Parameters:
responseName
- The extendedRespose OIDmessageId
- The original message IDserializedResponse
- The serialized response payload- Returns:
- The extendedResponse instance
- Throws:
DecoderException
- If the payload is incorrect
-
newExtendedRequest
ExtendedRequest newExtendedRequest(String oid, byte[] value)
Creates a new ExtendedRequest instance.- Parameters:
oid
- the extended request's object identifiervalue
- the encoded value of the extended request- Returns:
- The new extended request
-
newIntermediateResponse
<I extends IntermediateResponse> I newIntermediateResponse(String responseName, int messageId, byte[] serializedResponse) throws DecoderException
Create an instance of a IntermediateResponse, knowing its OID. Inject the payload into it.- Type Parameters:
I
- The intermediate response type- Parameters:
responseName
- The intermediateRespose OIDmessageId
- The original message IDserializedResponse
- The serialized response payload- Returns:
- The intermediateResponse instance
- Throws:
DecoderException
- If the payload is incorrect
-
decorate
ExtendedRequestDecorator<?> decorate(ExtendedRequest decoratedMessage)
Decorates an extended request message, ie encapsulate it into a class that do the encoding/decoding- Parameters:
decoratedMessage
- The extended request to decorate- Returns:
- The decorated extended request
-
decorate
ExtendedResponseDecorator<?> decorate(ExtendedResponse decoratedMessage)
Decorates an extended response message, ie encapsulate it into a class that do the encoding/decoding- Parameters:
decoratedMessage
- The extended response to decorate- Returns:
- The decorated extended response
-
decorate
IntermediateResponseDecorator<?> decorate(IntermediateResponse decoratedMessage)
Decorates an intermediate response message, ie encapsulate it into a class that do the encoding/decoding- Parameters:
decoratedMessage
- The intermediate response to decorate- Returns:
- The decorated intermediate response
-
-