|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.protocol.shared.AbstractProtocolService
org.apache.directory.server.protocol.shared.DirectoryBackedService
org.apache.directory.server.ldap.LdapService
public class LdapService
An LDAP protocol provider implementation which dynamically associates handlers.
Field Summary | |
---|---|
static int |
NO_SIZE_LIMIT
Value (0) for configuration where size limit is unlimited. |
static int |
NO_TIME_LIMIT
Value (0) for configuration where time limit is unlimited. |
static java.lang.String |
SERVICE_NAME
the constant service name of this ldap protocol provider |
Constructor Summary | |
---|---|
LdapService()
Creates an LDAP protocol provider. |
Method Summary | |
---|---|
void |
addExtendedOperationHandler(ExtendedOperationHandler eoh)
Registeres the specified ExtendedOperationHandler to this
protocol provider to provide a specific LDAP extended operation. |
MechanismHandler |
addSaslMechanismHandler(java.lang.String mechanism,
MechanismHandler handler)
|
org.apache.mina.handler.demux.MessageHandler<org.apache.directory.shared.ldap.message.AbandonRequest> |
getAbandonHandler()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.AddRequest> |
getAddHandler()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.BindRequest> |
getBindHandler()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.CompareRequest> |
getCompareHandler()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.DeleteRequest> |
getDeleteHandler()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.ExtendedRequest> |
getExtendedHandler()
|
ExtendedOperationHandler |
getExtendedOperationHandler(java.lang.String oid)
Returns an ExtendedOperationHandler with the specified oid
which is registered to this protocol provider. |
java.util.Collection<ExtendedOperationHandler> |
getExtendedOperationHandlers()
Gets the ExtendedOperationHandler s. |
org.apache.mina.common.IoHandler |
getHandler()
|
LdapSessionManager |
getLdapSessionManager()
|
int |
getMaxSizeLimit()
Returns the maximum size limit in number of entries to return for search. |
int |
getMaxTimeLimit()
Returns the maximum time limit in milliseonds to conduct a search. |
MechanismHandler |
getMechanismHandler(java.lang.String mechanism)
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyDnRequest> |
getModifyDnHandler()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyRequest> |
getModifyHandler()
|
java.lang.String |
getName()
|
org.apache.mina.filter.codec.ProtocolCodecFactory |
getProtocolCodecFactory()
|
java.lang.String |
getSaslHost()
Returns the FQDN of this SASL host, validated during SASL negotiation. |
java.util.Map<java.lang.String,MechanismHandler> |
getSaslMechanismHandlers()
|
java.lang.String |
getSaslPrincipal()
Returns the Kerberos principal name for this LDAP service, used by GSSAPI. |
java.util.Set<java.lang.String> |
getSaslQop()
Returns the Set of quality-of-protection, used by DIGEST-MD5 and GSSAPI. |
java.lang.String |
getSaslQopString()
Returns the quality-of-protection, used by DIGEST-MD5 and GSSAPI. |
java.util.List<java.lang.String> |
getSaslRealms()
Returns the realms serviced by this SASL host, used by DIGEST-MD5 and GSSAPI. |
LdapRequestHandler<org.apache.directory.shared.ldap.message.SearchRequest> |
getSearchHandler()
|
java.util.Set<java.lang.String> |
getSupportedControls()
|
java.util.Set<java.lang.String> |
getSupportedMechanisms()
|
LdapRequestHandler<org.apache.directory.shared.ldap.message.UnbindRequest> |
getUnbindHandler()
|
boolean |
isAllowAnonymousAccess()
Returns true if anonymous access is allowed. |
boolean |
isConfidentialityRequired()
Gets whether or not TLS secured connections are required to perform operations on this LdapService. |
boolean |
isEnableLdaps()
Returns true if LDAPS is enabled. |
boolean |
isStarted()
Gets whether or not this service has been started. |
void |
removeExtendedOperationHandler(java.lang.String oid)
Deregisteres an ExtendedOperationHandler with the specified oid
from this protocol provider. |
MechanismHandler |
removeSaslMechanismHandler(java.lang.String mechanism)
|
void |
setAbandonHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.AbandonRequest> abandonHandler)
|
void |
setAddHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.AddRequest> addHandler)
|
void |
setAllowAnonymousAccess(boolean enableAnonymousAccess)
Sets whether to allow anonymous access or not. |
void |
setBindHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.BindRequest> bindHandler)
|
void |
setCompareHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.CompareRequest> compareHandler)
|
void |
setConfidentialityRequired(boolean confidentialityRequired)
Sets the mode for this LdapService to accept requests with or without a TLS secured connection via either StartTLS extended operations or using LDAPS. |
void |
setDeleteHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.DeleteRequest> deleteHandler)
|
void |
setDirectoryService(DirectoryService directoryService)
Sets the DirectoryService assigned to this ProtocolService. |
void |
setEnableLdaps(boolean enableLdaps)
Sets if LDAPS is enabled or not. |
void |
setExtendedHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.ExtendedRequest> extendedHandler)
|
void |
setExtendedOperationHandlers(java.util.Collection<ExtendedOperationHandler> handlers)
Sets the ExtendedOperationHandler s. |
void |
setMaxSizeLimit(int maxSizeLimit)
Sets the maximum size limit in number of entries to return for search. |
void |
setMaxTimeLimit(int maxTimeLimit)
Sets the maximum time limit in miliseconds to conduct a search. |
void |
setModifyDnHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyDnRequest> modifyDnHandler)
|
void |
setModifyHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyRequest> modifyHandler)
|
void |
setSaslHost(java.lang.String saslHost)
Sets the FQDN of this SASL host, validated during SASL negotiation. |
void |
setSaslMechanismHandlers(java.util.Map<java.lang.String,MechanismHandler> saslMechanismHandlers)
|
void |
setSaslPrincipal(java.lang.String saslPrincipal)
Sets the Kerberos principal name for this LDAP service, used by GSSAPI. |
void |
setSaslQop(java.util.Set<java.lang.String> saslQop)
Sets the desired quality-of-protection, used by DIGEST-MD5 and GSSAPI. |
void |
setSaslRealms(java.util.List<java.lang.String> saslRealms)
Sets the realms serviced by this SASL host, used by DIGEST-MD5 and GSSAPI. |
void |
setSearchHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.SearchRequest> searchHandler)
|
void |
setStarted(boolean started)
|
void |
setSupportedControls(java.util.Set<java.lang.String> supportedControls)
|
void |
setUnbindHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.UnbindRequest> unbindHandler)
|
void |
start()
Starts this ProtocolService which binds acceptors on the protocol port. |
void |
stop()
Stops this ProtocolService which unbinds acceptors on the protocol port. |
Methods inherited from class org.apache.directory.server.protocol.shared.DirectoryBackedService |
---|
getSearchBaseDn, isCatelogBased, setCatelogBased, setSearchBaseDn |
Methods inherited from class org.apache.directory.server.protocol.shared.AbstractProtocolService |
---|
getDatagramAcceptor, getDirectoryService, getIpAddress, getIpPort, getServiceId, getServiceName, getSocketAcceptor, getTransportProtocols, isEnabled, setDatagramAcceptor, setEnabled, setIpAddress, setIpPort, setServiceId, setServiceName, setSocketAcceptor, setTransportProtocols |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_SIZE_LIMIT
public static final int NO_TIME_LIMIT
public static final java.lang.String SERVICE_NAME
Constructor Detail |
---|
public LdapService()
Method Detail |
---|
public void start() throws java.lang.Exception
ProtocolService
java.io.IOException
- if we cannot bind to the specified port
NamingException
- if the LDAP server cannot be started
java.lang.Exception
- if there are problems starting this servicepublic void stop()
ProtocolService
public java.lang.String getName()
public org.apache.mina.common.IoHandler getHandler()
public LdapSessionManager getLdapSessionManager()
public org.apache.mina.filter.codec.ProtocolCodecFactory getProtocolCodecFactory()
public void addExtendedOperationHandler(ExtendedOperationHandler eoh) throws java.lang.Exception
ExtendedOperationHandler
to this
protocol provider to provide a specific LDAP extended operation.
eoh
- an extended operation handler
NamingException
- on failure to add the handler
java.lang.Exception
public void removeExtendedOperationHandler(java.lang.String oid)
ExtendedOperationHandler
with the specified oid
from this protocol provider.
oid
- the numeric identifier for the extended operation associated with
the handler to removepublic ExtendedOperationHandler getExtendedOperationHandler(java.lang.String oid)
ExtendedOperationHandler
with the specified oid
which is registered to this protocol provider.
oid
- the oid of the extended request of associated with the extended
request handler
public void setConfidentialityRequired(boolean confidentialityRequired)
confidentialityRequired
- true to require confidentialitypublic boolean isConfidentialityRequired()
public boolean isEnableLdaps()
public void setEnableLdaps(boolean enableLdaps)
enableLdaps
- Whether LDAPS is enabled.public boolean isAllowAnonymousAccess()
true
if anonymous access is allowed.
public void setAllowAnonymousAccess(boolean enableAnonymousAccess)
enableAnonymousAccess
- Set true
to allow anonymous access.public void setMaxSizeLimit(int maxSizeLimit)
maxSizeLimit
- the maximum number of entries to return for searchpublic int getMaxSizeLimit()
public void setMaxTimeLimit(int maxTimeLimit)
maxTimeLimit
- the maximum length of time in milliseconds for searchpublic int getMaxTimeLimit()
public java.util.Collection<ExtendedOperationHandler> getExtendedOperationHandlers()
ExtendedOperationHandler
s.
ExtendedOperationHandler
s.public void setExtendedOperationHandlers(java.util.Collection<ExtendedOperationHandler> handlers)
ExtendedOperationHandler
s.
handlers
- A collection of ExtendedOperationHandler
s.public java.lang.String getSaslHost()
public void setSaslHost(java.lang.String saslHost)
saslHost
- The FQDN of this SASL host, validated during SASL negotiation.public java.lang.String getSaslPrincipal()
public void setSaslPrincipal(java.lang.String saslPrincipal)
saslPrincipal
- The Kerberos principal name for this LDAP service, used by GSSAPI.public java.lang.String getSaslQopString()
public java.util.Set<java.lang.String> getSaslQop()
public void setSaslQop(java.util.Set<java.lang.String> saslQop)
saslQop
- The desired quality-of-protection, used by DIGEST-MD5 and GSSAPI.public java.util.List<java.lang.String> getSaslRealms()
public void setSaslRealms(java.util.List<java.lang.String> saslRealms)
saslRealms
- The realms serviced by this SASL host, used by DIGEST-MD5 and GSSAPI.public java.util.Map<java.lang.String,MechanismHandler> getSaslMechanismHandlers()
public void setSaslMechanismHandlers(java.util.Map<java.lang.String,MechanismHandler> saslMechanismHandlers)
public MechanismHandler addSaslMechanismHandler(java.lang.String mechanism, MechanismHandler handler)
public MechanismHandler removeSaslMechanismHandler(java.lang.String mechanism)
public MechanismHandler getMechanismHandler(java.lang.String mechanism)
public java.util.Set<java.lang.String> getSupportedMechanisms()
public void setDirectoryService(DirectoryService directoryService)
ProtocolService
setDirectoryService
in interface ProtocolService
setDirectoryService
in class AbstractProtocolService
directoryService
- the directory service core assigned to this servicepublic java.util.Set<java.lang.String> getSupportedControls()
public void setSupportedControls(java.util.Set<java.lang.String> supportedControls)
public org.apache.mina.handler.demux.MessageHandler<org.apache.directory.shared.ldap.message.AbandonRequest> getAbandonHandler()
public void setAbandonHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.AbandonRequest> abandonHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.AddRequest> getAddHandler()
public void setAddHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.AddRequest> addHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.BindRequest> getBindHandler()
public void setBindHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.BindRequest> bindHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.CompareRequest> getCompareHandler()
public void setCompareHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.CompareRequest> compareHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.DeleteRequest> getDeleteHandler()
public void setDeleteHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.DeleteRequest> deleteHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.ExtendedRequest> getExtendedHandler()
public void setExtendedHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.ExtendedRequest> extendedHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyRequest> getModifyHandler()
public void setModifyHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyRequest> modifyHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyDnRequest> getModifyDnHandler()
public void setModifyDnHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.ModifyDnRequest> modifyDnHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.SearchRequest> getSearchHandler()
public void setSearchHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.SearchRequest> searchHandler)
public LdapRequestHandler<org.apache.directory.shared.ldap.message.UnbindRequest> getUnbindHandler()
public void setUnbindHandler(LdapRequestHandler<org.apache.directory.shared.ldap.message.UnbindRequest> unbindHandler)
public boolean isStarted()
ProtocolService
isStarted
in interface ProtocolService
isStarted
in class AbstractProtocolService
public void setStarted(boolean started)
setStarted
in class AbstractProtocolService
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |