public interface LdapApiService
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_PROTOCOL_CODEC_FACTORY
The default codec factory
|
Modifier and Type | Method and Description |
---|---|
ExtendedRequest |
fromJndi(ExtendedRequest jndiRequest)
Creates a model ExtendedResponse from the JNDI ExtendedRequest.
|
ExtendedResponse |
fromJndi(ExtendedResponse jndiResponse)
Creates a model ExtendedResponse from the JNDI ExtendedResponse.
|
Control |
fromJndiRequestControl(Control jndiControl)
Creates a model request control from the JNDI request control.
|
Control |
fromJndiResponseControl(Control jndiControl)
Creates a model response control from the JNDI response control.
|
Map<String,ExtendedOperationFactory> |
getExtendedRequestFactories() |
Map<String,ExtendedOperationFactory> |
getExtendedResponseFactories() |
Map<String,IntermediateOperationFactory> |
getIntermediateResponseFactories() |
org.apache.mina.filter.codec.ProtocolCodecFactory |
getProtocolCodecFactory()
Creates a new LDAP
ProtocolCodecFactory . |
Map<String,ControlFactory<? extends Control>> |
getRequestControlFactories() |
Map<String,ControlFactory<? extends Control>> |
getResponseControlFactories() |
boolean |
isControlRegistered(String oid)
Checks if a control has been registered.
|
boolean |
isExtendedRequestRegistered(String oid)
Checks to see if an extended request operation is registered.
|
boolean |
isExtendedResponseRegistered(String oid)
Checks to see if an extended response operation is registered.
|
boolean |
isIntermediateResponseRegistered(String oid)
Checks to see if an intermediate response is registered.
|
Iterator<String> |
registeredExtendedRequests()
Returns an Iterator over the OID Strings of registered extended
requests.
|
Iterator<String> |
registeredExtendedResponses()
Returns an Iterator over the OID Strings of registered extended
responses.
|
Iterator<String> |
registeredIntermediateResponses()
Returns an Iterator over the OID Strings of registered intermediate
responses.
|
Iterator<String> |
registeredRequestControls()
Returns an Iterator over the OID Strings of registered request controls.
|
Iterator<String> |
registeredResponseControls()
Returns an Iterator over the OID Strings of registered response controls.
|
ExtendedOperationFactory |
registerExtendedRequest(ExtendedOperationFactory factory)
Registers an
ExtendedOperationFactory for generating extended request
response pairs. |
ExtendedOperationFactory |
registerExtendedResponse(ExtendedOperationFactory factory)
Registers an
ExtendedOperationFactory for generating extended response
response pairs. |
IntermediateOperationFactory |
registerIntermediateResponse(IntermediateOperationFactory factory)
Registers an
IntermediateOperationFactory for generating intermediate response |
org.apache.mina.filter.codec.ProtocolCodecFactory |
registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory factory)
Registers a ProtocolCodecFactory with this LdapCodecService.
|
ControlFactory<?> |
registerRequestControl(ControlFactory<?> factory)
Registers an request
ControlFactory with this service. |
ControlFactory<?> |
registerResponseControl(ControlFactory<?> factory)
Registers an response
ControlFactory with this service. |
ExtendedRequest |
toJndi(ExtendedRequest modelRequest)
Creates a JNDI
ExtendedRequest from the model
ExtendedRequest . |
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.
|
ExtendedOperationFactory |
unregisterExtendedRequest(String oid)
Unregisters an
ExtendedOperationFactory for generating extended
request response pairs. |
ExtendedOperationFactory |
unregisterExtendedResponse(String oid)
Unregisters an
ExtendedOperationFactory for generating extended
responses. |
IntermediateOperationFactory |
unregisterIntermediateResponse(String oid)
Unregisters an
IntermediateOperationFactory for generating intermediate
response |
ControlFactory<?> |
unregisterRequestControl(String oid)
Unregisters a request
ControlFactory with this service. |
ControlFactory<?> |
unregisterResponseControl(String oid)
Unregisters a response
ControlFactory with this service. |
static final String DEFAULT_PROTOCOL_CODEC_FACTORY
Iterator<String> registeredRequestControls()
Iterator<String> registeredResponseControls()
boolean isControlRegistered(String oid)
oid
- The Control OID we are looking forControlFactory<?> registerRequestControl(ControlFactory<?> factory)
ControlFactory
with this service.factory
- The control factoryControlFactory<?> registerResponseControl(ControlFactory<?> factory)
ControlFactory
with this service.factory
- The control factoryControlFactory<?> unregisterRequestControl(String oid)
ControlFactory
with this service.oid
- The oid of the control the factory is associated with.ControlFactory<?> unregisterResponseControl(String oid)
ControlFactory
with this service.oid
- The oid of the control the factory is associated with.Control toJndiControl(Control modelControl) throws EncoderException
modelControl
- The model's control.EncoderException
- if there are problems encoding the modelControl.Control fromJndiRequestControl(Control jndiControl) throws DecoderException
jndiControl
- The JNDI control.DecoderException
- if there are problems decoding the value of the JNDI control.Control fromJndiResponseControl(Control jndiControl) throws DecoderException
jndiControl
- The JNDI response control.DecoderException
- if there are problems decoding the value of the JNDI control.Map<String,ControlFactory<? extends Control>> getRequestControlFactories()
Map<String,ControlFactory<? extends Control>> getResponseControlFactories()
Iterator<String> registeredExtendedRequests()
Iterator<String> registeredExtendedResponses()
ExtendedOperationFactory registerExtendedRequest(ExtendedOperationFactory factory)
ExtendedOperationFactory
for generating extended request
response pairs.factory
- The extended request factoryExtendedOperationFactory registerExtendedResponse(ExtendedOperationFactory factory)
ExtendedOperationFactory
for generating extended response
response pairs.factory
- The extended response factoryExtendedOperationFactory unregisterExtendedRequest(String oid)
ExtendedOperationFactory
for generating extended
request response pairs.oid
- The extended request oidExtendedOperationFactory unregisterExtendedResponse(String oid)
ExtendedOperationFactory
for generating extended
responses.oid
- The extended response oidboolean isExtendedRequestRegistered(String oid)
oid
- The object identifier for the extended request operationboolean isExtendedResponseRegistered(String oid)
oid
- The object identifier for the extended response operationMap<String,ExtendedOperationFactory> getExtendedRequestFactories()
Map<String,ExtendedOperationFactory> getExtendedResponseFactories()
Iterator<String> registeredIntermediateResponses()
IntermediateOperationFactory registerIntermediateResponse(IntermediateOperationFactory factory)
IntermediateOperationFactory
for generating intermediate responsefactory
- The intermediate response factoryIntermediateOperationFactory unregisterIntermediateResponse(String oid)
IntermediateOperationFactory
for generating intermediate
responseoid
- The intermediate response oidboolean isIntermediateResponseRegistered(String oid)
oid
- The object identifier for the intermediate responseMap<String,IntermediateOperationFactory> getIntermediateResponseFactories()
ExtendedResponse 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
- The extended response to convertEncoderException
- If the conversion failedExtendedRequest fromJndi(ExtendedRequest jndiRequest) throws DecoderException
jndiRequest
- The JNDI ExtendedRequestDecoderException
- if the request value cannot be decoded.ExtendedRequest toJndi(ExtendedRequest modelRequest) throws EncoderException
ExtendedRequest
from the model
ExtendedRequest
.modelRequest
- The extended request to convertEncoderException
- If the conversion failedorg.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.Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.