Package org.apache.directory.fortress.core.model

Class Bind

  • All Implemented Interfaces:
    Serializable
    public class Bind
extends FortEntity
implements Serializable
    This entity class contains OpenLDAP slapd access log records that correspond to bind attempts made to the directory.

    The auditBind Structural object class is used to store authentication events that can later be queried via ldap API.
    # The Bind class includes the reqVersion attribute which contains the LDAP # protocol version specified in the Bind as well as the reqMethod attribute # which contains the Bind Method used in the Bind. This will be the string # SIMPLE for LDAP Simple Binds or SASL(mech) for SASL Binds. Note that unless # configured as a global overlay, only Simple Binds using DNs that reside in # the current database will be logged: 

     ------------------------------------------
 objectclass (  1.3.6.1.4.1.4203.666.11.5.2.6 NAME 'auditBind'
 DESC 'Bind operation'
 SUP auditObject STRUCTURAL
 MUST ( reqVersion $ reqMethod ) )
 ------------------------------------------

    Note this class used descriptions pulled from man pages on slapd access log.

    Author:
    Apache Directory Project
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Bind()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getCreateTimestamp()
      Get the attribute that maps to 'reqStart' which provides the start time of the operation which is also the rDn for the node.
      String getCreatorsName()
      Return the user dn containing the identity of log user who added the audit record.
      String getEntryCSN()
      Return the Change Sequence Number (CSN) containing sequence number that is used for OpenLDAP synch replication functionality.
      String getEntryDN()
      Get the entry dn for bind object stored in directory.
      String getEntryUUID()
      Get the attribute that contains the Universally Unique ID (UUID) of the corresponding 'auditBind' record.
      String getHasSubordinates()
      Get the attribute that corresponds to the boolean value hasSubordinates.
      String getModifiersName()
      Return the user dn containing the identity of log user who last modified the audit record.
      String getModifyTimestamp()
      Get the attribute that maps to 'modifyTimestamp' which provides the last time audit record was changed.
      String getObjectClass()
      Get the object class name of the audit record.
      String getReqAuthzID()
      The reqAuthzID attribute is the distinguishedName of the user that performed the operation.
      String getReqControls()
      The reqControls and reqRespControls attributes carry any controls sent by the client on the request and returned by the server in the response, respectively.
      String getReqDN()
      The reqDN attribute is the distinguishedName of the target of the operation.
      String getReqEnd()
      reqEnd provide the end time of the operation.
      String getReqMethod()
      The reqMethod attribute contains the Bind Method used in the Bind.
      String getReqResult()
      The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code.
      String getReqSession()
      The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session.
      String getReqStart()
      reqStart provide the start of the operation, They use generalizedTime syntax.
      String getReqType()
      The reqType attribute is a simple string containing the type of operation being logged, e.g.
      String getReqVersion()
      The reqVersion attribute which contains the LDAP protocol version specified in the Bind
      long getSequenceId()
      Sequence id is used internal to Fortress.
      String getStructuralObjectClass()
      Returns the name of the structural object class that is used to log the event.
      void setCreateTimestamp​(String createTimestamp)
      Set the attribute that maps to 'reqStart' which provides the start time of the operation which is also the rDn for the node.
      void setCreatorsName​(String creatorsName)
      Set the user dn containing the identity of log user who added the audit record.
      void setEntryCSN​(String entryCSN)
      Set the Change Sequence Number (CSN) containing sequence number that is used for OpenLDAP synch replication functionality.
      void setEntryDN​(String entryDN)
      Set the entry dn for bind object stored in directory.
      void setEntryUUID​(String entryUUID)
      Set the attribute that contains the Universally Unique ID (UUID) of the corresponding 'auditBind' record.
      void setHasSubordinates​(String hasSubordinates)
      Set the attribute that corresponds to the boolean value hasSubordinates.
      void setModifiersName​(String modifiersName)
      Set the user dn containing the identity of log user who modified the audit record.
      void setModifyTimestamp​(String modifyTimestamp)
      Set the attribute that maps to 'modifyTimestamp' which provides the last time audit record was changed.
      void setObjectClass​(String objectClass)
      Set the object class name of the audit record.
      void setReqAuthzID​(String reqAuthzID)
      The reqAuthzID attribute is the distinguishedName of the user that performed the operation.
      void setReqControls​(String reqControls)
      The reqControls and reqRespControls attributes carry any controls sent by the client on the request and returned by the server in the response, respectively.
      void setReqDN​(String reqDN)
      The reqDN attribute is the distinguishedName of the target of the operation.
      void setReqEnd​(String reqEnd)
      reqEnd provide the end time of the operation.
      void setReqMethod​(String reqMethod)
      The reqMethod attribute contains the Bind Method used in the Bind.
      void setReqResult​(String reqResult)
      The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code.
      void setReqSession​(String reqSession)
      The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session.
      void setReqStart​(String reqStart)
      reqStart provide the start of the operation, They use generalizedTime syntax.
      void setReqType​(String reqType)
      The reqType attribute is a simple string containing the type of operation being logged, e.g.
      void setReqVersion​(String reqVersion)
      The reqVersion attribute which contains the LDAP protocol version specified in the Bind
      void setSequenceId​(long sequenceId)
      Sequence id is used internal to Fortress
      void setStructuralObjectClass​(String structuralObjectClass)
      Returns the name of the structural object class that is used to log the event.

    • Constructor Detail

      • Bind

        public Bind()

    • Method Detail

      • getCreateTimestamp

        public String getCreateTimestamp()
        Get the attribute that maps to 'reqStart' which provides the start time of the operation which is also the rDn for the node. These time attributes use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.
        Returns:
        attribute that maps to 'reqStart' in 'auditBind' object class.

      • setCreateTimestamp

        public void setCreateTimestamp​(String createTimestamp)
        Set the attribute that maps to 'reqStart' which provides the start time of the operation which is also the rDn for the node. These time attributes use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.
        Parameters:
        createTimestamp - attribute that maps to 'reqStart' in 'auditBind' object class.

      • getCreatorsName

        public String getCreatorsName()
        Return the user dn containing the identity of log user who added the audit record. This will be the system user that is configured for performing slapd access log operations on behalf of Fortress.
        Returns:
        value that maps to 'creatorsName' attribute on 'auditBind' object class.

      • setCreatorsName

        public void setCreatorsName​(String creatorsName)
        Set the user dn containing the identity of log user who added the audit record. This will be the system user that is configured for performing slapd access log operations on behalf of Fortress.
        Parameters:
        creatorsName - maps to 'creatorsName' attribute on 'auditBind' object class.

      • getEntryCSN

        public String getEntryCSN()
        Return the Change Sequence Number (CSN) containing sequence number that is used for OpenLDAP synch replication functionality.
        Returns:
        attribute that maps to 'entryCSN' on 'auditBind' object class.

      • setEntryCSN

        public void setEntryCSN​(String entryCSN)
        Set the Change Sequence Number (CSN) containing sequence number that is used for OpenLDAP synch replication functionality.
        Parameters:
        entryCSN - maps to 'entryCSN' attribute on 'auditBind' object class.

      • getEntryDN

        public String getEntryDN()
        Get the entry dn for bind object stored in directory. This attribute uses the 'reqStart' along with suffix for log.
        Returns:
        attribute that maps to 'entryDN' on 'auditBind' object class.

      • setEntryDN

        public void setEntryDN​(String entryDN)
        Set the entry dn for bind object stored in directory. This attribute uses the 'reqStart' along with suffix for log.
        Parameters:
        entryDN - attribute that maps to 'entryDN' on 'auditBind' object class.

      • getEntryUUID

        public String getEntryUUID()
        Get the attribute that contains the Universally Unique ID (UUID) of the corresponding 'auditBind' record.
        Returns:
        value that maps to 'entryUUID' attribute on 'auditBind' object class.

      • setEntryUUID

        public void setEntryUUID​(String entryUUID)
        Set the attribute that contains the Universally Unique ID (UUID) of the corresponding 'auditBind' record.
        Parameters:
        entryUUID - that maps to 'entryUUID' attribute on 'auditBind' object class.

      • getHasSubordinates

        public String getHasSubordinates()
        Get the attribute that corresponds to the boolean value hasSubordinates.
        Returns:
        value that maps to 'hasSubordinates' attribute on 'auditBind' object class.

      • setHasSubordinates

        public void setHasSubordinates​(String hasSubordinates)
        Set the attribute that corresponds to the boolean value hasSubordinates.
        Parameters:
        hasSubordinates - maps to same name on 'auditBind' object class.

      • getModifiersName

        public String getModifiersName()
        Return the user dn containing the identity of log user who last modified the audit record. This will be the system user that is configured for performing slapd access log operations on behalf of Fortress.
        Returns:
        value that maps to 'modifiersName' attribute on 'auditBind' object class.

      • setModifiersName

        public void setModifiersName​(String modifiersName)
        Set the user dn containing the identity of log user who modified the audit record. This will be the system user that is configured for performing slapd access log operations on behalf of Fortress.
        Parameters:
        modifiersName - maps to 'modifiersName' attribute on 'auditBind' object class.

      • getModifyTimestamp

        public String getModifyTimestamp()
        Get the attribute that maps to 'modifyTimestamp' which provides the last time audit record was changed. The time attributes use generalizedTime syntax.
        Returns:
        attribute that maps to 'modifyTimestamp' in 'auditBind' object class.

      • setModifyTimestamp

        public void setModifyTimestamp​(String modifyTimestamp)
        Set the attribute that maps to 'modifyTimestamp' which provides the last time audit record was changed. The time attributes use generalizedTime syntax.
        Parameters:
        modifyTimestamp - attribute that maps to same name in 'auditBind' object class.

      • getObjectClass

        public String getObjectClass()
        Get the object class name of the audit record. For this entity, this value will always be 'auditBind'.
        Returns:
        value that maps to 'objectClass' attribute on 'auditBind' obejct class.

      • setObjectClass

        public void setObjectClass​(String objectClass)
        Set the object class name of the audit record. For this entity, this value will always be 'auditBind'.
        Parameters:
        objectClass - value that maps to same name on 'auditBind' obejct class.

      • getReqAuthzID

        public String getReqAuthzID()
        The reqAuthzID attribute is the distinguishedName of the user that performed the operation. This will usually be the same name as was established at the start of a session by a Bind request (if any) but may be altered in various circumstances. For Fortress bind operations this will map to User#userId
        Returns:
        value that maps to 'reqAuthzID' on 'auditBind' object class.

      • setReqAuthzID

        public void setReqAuthzID​(String reqAuthzID)
        The reqAuthzID attribute is the distinguishedName of the user that performed the operation. This will usually be the same name as was established at the start of a session by a Bind request (if any) but may be altered in various circumstances. For Fortress bind operations this will map to User#userId

      • getReqControls

        public String getReqControls()
        The reqControls and reqRespControls attributes carry any controls sent by the client on the request and returned by the server in the response, respectively. The attribute values are just uninterpreted octet strings.
        Returns:
        value that maps to 'reqControls' attribute on 'auditBind' object class.

      • setReqControls

        public void setReqControls​(String reqControls)
        The reqControls and reqRespControls attributes carry any controls sent by the client on the request and returned by the server in the response, respectively. The attribute values are just uninterpreted octet strings.
        Parameters:
        reqControls - maps to same name attribute on 'auditBind' object class.

      • getReqDN

        public String getReqDN()
        The reqDN attribute is the distinguishedName of the target of the operation. E.g., for a Bind request, this is the Bind DN. For an Add request, this is the DN of the entry being added. For a Search request, this is the base DN of the search.
        Returns:
        value that map to 'reqDN' attribute on 'auditBind' object class.

      • setReqDN

        public void setReqDN​(String reqDN)
        The reqDN attribute is the distinguishedName of the target of the operation. E.g., for a Bind request, this is the Bind DN. For an Add request, this is the DN of the entry being added. For a Search request, this is the base DN of the search.
        Parameters:
        reqDN - maps to 'reqDN' attribute on 'auditBind' object class.

      • getReqEnd

        public String getReqEnd()
        reqEnd provide the end time of the operation. It uses generalizedTime syntax.
        Returns:
        value that maps to 'reqEnd' attribute on 'auditBind' object class.

      • setReqEnd

        public void setReqEnd​(String reqEnd)
        reqEnd provide the end time of the operation. It uses generalizedTime syntax.
        Parameters:
        reqEnd - value that maps to same name on 'auditBind' object class.

      • getReqMethod

        public String getReqMethod()
        The reqMethod attribute contains the Bind Method used in the Bind. This will be the string SIMPLE for LDAP Simple Binds or SASL() for SASL Binds. Note that unless configured as a global overlay, only Simple Binds using DNs that reside in the current database will be logged.
        Returns:
        String that maps to 'reqMethod' attribute on 'auditBind' object class.

      • setReqMethod

        public void setReqMethod​(String reqMethod)
        The reqMethod attribute contains the Bind Method used in the Bind. This will be the string SIMPLE for LDAP Simple Binds or SASL() for SASL Binds. Note that unless configured as a global overlay, only Simple Binds using DNs that reside in the current database will be logged.
        Parameters:
        reqMethod - maps to same name on 'auditBind' object class.

      • getReqResult

        public String getReqResult()
        The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code. An error code may be accompanied by a text error message which will be recorded in the reqMessage attribute.
        Returns:
        value that maps to 'reqResult' attribute on 'auditBind' object class.

      • setReqResult

        public void setReqResult​(String reqResult)
        The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code. An error code may be accompanied by a text error message which will be recorded in the reqMessage attribute.
        Parameters:
        reqResult - maps to same name on 'auditBind' object class.

      • getReqSession

        public String getReqSession()
        The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session. Currently this is slapd's internal connection ID, stored in decimal.
        Returns:
        value that maps to 'reqSession' attribute on 'auditBind' object class.

      • setReqSession

        public void setReqSession​(String reqSession)
        The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session. Currently this is slapd's internal connection ID, stored in decimal.
        Parameters:
        reqSession - maps to same name on 'auditBind' object class.

      • getReqStart

        public String getReqStart()
        reqStart provide the start of the operation, They use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.
        Returns:
        value that maps to 'reqStart' attribute on 'auditBind' object class.

      • setReqStart

        public void setReqStart​(String reqStart)
        reqStart provide the start of the operation, They use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.
        Parameters:
        reqStart - maps to same name on 'auditBind' object class.

      • getReqType

        public String getReqType()
        The reqType attribute is a simple string containing the type of operation being logged, e.g. add, delete, search, etc. For extended operations, the type also includes the OID of the extended operation, e.g. extended(1.1.1.1)
        Returns:
        value that maps to 'reqType' attribute on 'auditBind' object class.

      • setReqType

        public void setReqType​(String reqType)
        The reqType attribute is a simple string containing the type of operation being logged, e.g. add, delete, search, etc. For extended operations, the type also includes the OID of the extended operation, e.g. extended(1.1.1.1)
        Parameters:
        reqType - maps to same name on 'auditBind' object class.

      • getReqVersion

        public String getReqVersion()
        The reqVersion attribute which contains the LDAP protocol version specified in the Bind
        Returns:
        value that maps to the 'reqVersion' attribute on 'auditBind' object class.

      • setReqVersion

        public void setReqVersion​(String reqVersion)
        The reqVersion attribute which contains the LDAP protocol version specified in the Bind
        Parameters:
        reqVersion - maps to same name on 'auditBind' object class.

      • getStructuralObjectClass

        public String getStructuralObjectClass()
        Returns the name of the structural object class that is used to log the event. For this entity this value will always be 'auditBind'.
        Returns:
        value that maps to 'structuralObjectClass' attribute that contains the name 'auditBind'.

      • setStructuralObjectClass

        public void setStructuralObjectClass​(String structuralObjectClass)
        Returns the name of the structural object class that is used to log the event. For this entity this value will always be 'auditBind'.
        Parameters:
        structuralObjectClass - maps to same name on 'auditBind' object class.

      • getSequenceId

        public long getSequenceId()
        Sequence id is used internal to Fortress.
        Overrides:
        getSequenceId in class FortEntity
        Returns:
        long value contains sequence id.

      • setSequenceId

        public void setSequenceId​(long sequenceId)
        Sequence id is used internal to Fortress
        Overrides:
        setSequenceId in class FortEntity
        Parameters:
        sequenceId - contains sequence to use.