Package com.ibm.di.parser

Class Dsmlv2Parser

    • Field Detail

      • PARAMETER_MODE

        public static final java.lang.String PARAMETER_MODE
        Parameter mode.
        See Also:
        Constant Field Values

      • PARAMETER_BINARY_ATTRIBUTES

        public static final java.lang.String PARAMETER_BINARY_ATTRIBUTES
        binaryAttributes config parameter name.
        See Also:
        Constant Field Values

      • PARAMETER_BATCH_REQUEST_ID

        public static final java.lang.String PARAMETER_BATCH_REQUEST_ID
        batchRequestId config parameter name.
        See Also:
        Constant Field Values

      • ATTR_NAME_ACUMULATOR

        public static final java.lang.String ATTR_NAME_ACUMULATOR
        resultEntries config parameter name.
        See Also:
        Constant Field Values

      • ATTR_NAME_DN

        public static final java.lang.String ATTR_NAME_DN
        Attribute name for distinguish number.
        See Also:
        Constant Field Values

      • ATTR_NAME_NEWRDN

        public static final java.lang.String ATTR_NAME_NEWRDN
        Attribute name for new RDN.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_BASE

        public static final java.lang.String ATTR_NAME_DSML_BASE
        Name of the DSML base attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_OPERATION

        public static final java.lang.String ATTR_NAME_DSML_OPERATION
        Name of the DSML operation attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_COMPARE_NAME

        public static final java.lang.String ATTR_NAME_DSML_COMPARE_NAME
        Attribute name for compare_name attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_COMPARE_VALUE

        public static final java.lang.String ATTR_NAME_DSML_COMPARE_VALUE
        Attribute name for compare_value attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_COMPARE_RESULT

        public static final java.lang.String ATTR_NAME_DSML_COMPARE_RESULT
        Attribute name for compare_value attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_ERROR_MESSAGE

        public static final java.lang.String ATTR_NAME_DSML_ERROR_MESSAGE
        Attribute name for error attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_RESULTCODE

        public static final java.lang.String ATTR_NAME_DSML_RESULTCODE
        Attribute name for resultcode attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_RESULTDESC

        public static final java.lang.String ATTR_NAME_DSML_RESULTDESC
        Attribute name for resultdescr attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_FILTER

        public static final java.lang.String ATTR_NAME_DSML_FILTER
        Attribute name for filter attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_ATTRIBUTES

        public static final java.lang.String ATTR_NAME_DSML_ATTRIBUTES
        Attribute name for attributes attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_SCOPE

        public static final java.lang.String ATTR_NAME_DSML_SCOPE
        Attribute name for scope attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_REQUEST_ID

        public static final java.lang.String ATTR_NAME_DSML_REQUEST_ID
        Attribute name for requestID attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_CONTROLS

        public static final java.lang.String ATTR_NAME_DSML_CONTROLS
        Attribute name for controls attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_EXCEPTION

        public static final java.lang.String ATTR_NAME_DSML_EXCEPTION
        Attribute name for exception attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_NEWSUPERIOR

        public static final java.lang.String ATTR_NAME_DSML_NEWSUPERIOR
        Attribute name for newSuperior attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_DELETEOLDRDN

        public static final java.lang.String ATTR_NAME_DSML_DELETEOLDRDN
        Attribute name for deleteOldRDN attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_DEREFALIASES

        public static final java.lang.String ATTR_NAME_DSML_DEREFALIASES
        Attribute name for derefAliases attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_SIZELIMIT

        public static final java.lang.String ATTR_NAME_DSML_SIZELIMIT
        Attribute name for sizeLimit attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_TIMELIMIT

        public static final java.lang.String ATTR_NAME_DSML_TIMELIMIT
        Attribute name for timeLimit attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_TYPESONLY

        public static final java.lang.String ATTR_NAME_DSML_TYPESONLY
        Attribute name for typesOnly attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_REFFERAL

        public static final java.lang.String ATTR_NAME_DSML_REFFERAL
        Attribute name for referral attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_PRINCIPAL

        public static final java.lang.String ATTR_NAME_DSML_PRINCIPAL
        Attribute name for principal attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_RESPONSE_NAME

        public static final java.lang.String ATTR_NAME_DSML_RESPONSE_NAME
        Attribute name for responseName attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_RESPONSE

        public static final java.lang.String ATTR_NAME_DSML_RESPONSE
        Attribute name for response attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_ERRORTYPE

        public static final java.lang.String ATTR_NAME_DSML_ERRORTYPE
        Attribute name for errorType attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_DETAILS

        public static final java.lang.String ATTR_NAME_DSML_DETAILS
        Attribute name for details attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_MESSAGE

        public static final java.lang.String ATTR_NAME_DSML_MESSAGE
        Attribute name for message attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_REQUEST_NAME

        public static final java.lang.String ATTR_NAME_DSML_REQUEST_NAME
        Attribute name for extended.requestname attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_REQUEST_VALUE

        public static final java.lang.String ATTR_NAME_DSML_REQUEST_VALUE
        Attribute name for extended.requestvalue attribute.
        See Also:
        Constant Field Values

      • ATTR_NAME_DSML_ABANDON_ID

        public static final java.lang.String ATTR_NAME_DSML_ABANDON_ID
        Attribute name for abandonID attribute.
        See Also:
        Constant Field Values

      • OPERATION_ADD_REQUEST

        public static final java.lang.String OPERATION_ADD_REQUEST
        Name of the add request.
        See Also:
        Constant Field Values

      • OPERATION_DELETE_REQUEST

        public static final java.lang.String OPERATION_DELETE_REQUEST
        Name of the delete request.
        See Also:
        Constant Field Values

      • OPERATION_SEARCH_REQUEST

        public static final java.lang.String OPERATION_SEARCH_REQUEST
        Name of the search request.
        See Also:
        Constant Field Values

      • OPERATION_COMPARE_REQUEST

        public static final java.lang.String OPERATION_COMPARE_REQUEST
        Name of the compare request.
        See Also:
        Constant Field Values

      • OPERATION_MODIFY_REQUEST

        public static final java.lang.String OPERATION_MODIFY_REQUEST
        Name of the modify request.
        See Also:
        Constant Field Values

      • OPERATION_MODIFYDN_REQUEST

        public static final java.lang.String OPERATION_MODIFYDN_REQUEST
        Name of the modify distinguish number request.
        See Also:
        Constant Field Values

      • OPERATION_EXTENDED_REQUEST

        public static final java.lang.String OPERATION_EXTENDED_REQUEST
        Name of the extended request.
        See Also:
        Constant Field Values

      • OPERATION_ABANDON_REQUEST

        public static final java.lang.String OPERATION_ABANDON_REQUEST
        Name of the abandon request.
        See Also:
        Constant Field Values

      • OPERATION_AUTH_REQUEST

        public static final java.lang.String OPERATION_AUTH_REQUEST
        Name of the authorization request.
        See Also:
        Constant Field Values

      • OPERATION_ADD_RESPONSE

        public static final java.lang.String OPERATION_ADD_RESPONSE
        Name of the add response.
        See Also:
        Constant Field Values

      • OPERATION_DELETE_RESPONSE

        public static final java.lang.String OPERATION_DELETE_RESPONSE
        Name of the delete response.
        See Also:
        Constant Field Values

      • OPERATION_SEARCH_RESPONSE

        public static final java.lang.String OPERATION_SEARCH_RESPONSE
        Name of the search response.
        See Also:
        Constant Field Values

      • OPERATION_COMPARE_RESPONSE

        public static final java.lang.String OPERATION_COMPARE_RESPONSE
        Name of the compare response.
        See Also:
        Constant Field Values

      • OPERATION_MODIFY_RESPONSE

        public static final java.lang.String OPERATION_MODIFY_RESPONSE
        Name of the modify response.
        See Also:
        Constant Field Values

      • OPERATION_MODIFYDN_RESPONSE

        public static final java.lang.String OPERATION_MODIFYDN_RESPONSE
        Name of the modify distinguish number response.
        See Also:
        Constant Field Values

      • OPERATION_EXTENDED_RESPONSE

        public static final java.lang.String OPERATION_EXTENDED_RESPONSE
        Name of the extended response.
        See Also:
        Constant Field Values

      • OPERATION_AUTH_RESPONSE

        public static final java.lang.String OPERATION_AUTH_RESPONSE
        Name of the authorization response.
        See Also:
        Constant Field Values

      • OPERATION_ERROR_RESPONSE

        public static final java.lang.String OPERATION_ERROR_RESPONSE
        Name of the error response.
        See Also:
        Constant Field Values

      • WHOLE_SUBTREE

        public static final java.lang.String WHOLE_SUBTREE
        Indicates search scope - whole tree.

        Note: From ITDS DSMLv2 library.

        See Also:
        Constant Field Values

      • DEREF_NEVER

        public static final java.lang.String DEREF_NEVER
        Default value used for search request.
        See Also:
        Constant Field Values

      • NS_URI_SOAP_ENV

        public static final java.lang.String NS_URI_SOAP_ENV
        Namespace URI for SOAP.

        For SOAP support.

        See Also:
        Constant Field Values

      • SOAP_ENV_QN

        public static final java.lang.String SOAP_ENV_QN
        Indicates SOAP envelope.
        See Also:
        Constant Field Values

      • XMLNS_NS

        public static final java.lang.String XMLNS_NS
        XML namespace URI.
        See Also:
        Constant Field Values

      • ATTR_SOAP_NS

        public static final java.lang.String ATTR_SOAP_NS
        SOAP namespace attribute.
        See Also:
        Constant Field Values

      • SOAP_BODY_QN

        public static final java.lang.String SOAP_BODY_QN
        SOAP body attribute.
        See Also:
        Constant Field Values

      • ATTR_DSML_NS

        public static final java.lang.String ATTR_DSML_NS
        DSML namespace attribute.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Dsmlv2Parser

        public Dsmlv2Parser()

    • Method Detail

      • getResponseOperation

        public static java.lang.String getResponseOperation​(java.lang.String aRequestOperation)
        This method maps request and response operations Used from DSMLv2 EventHandler
        Parameters:
        aRequestOperation - The request operation that will be mapped
        Returns:
        response of corresponding request operation

      • initParser

        public void initParser()
                throws java.lang.Exception
        Initializes the parser.
        Specified by:
        initParser in interface ParserInterface
        Overrides:
        initParser in class ParserImpl
        Throws:
        java.lang.Exception - if initialization fails

      • readEntry

        public Entry readEntry()
                throws java.lang.Exception
        Reads a request or response from BatchMessage.
        Returns:
        next entry
        Throws:
        java.lang.Exception - Throws exception if type of request or response not recognized

      • writeEntry

        public void writeEntry​(Entry aEntry)
                throws java.lang.Exception
        Writes a request or response to the batch message.
        Parameters:
        aEntry - The entry which will be written
        Throws:
        java.lang.Exception - Throws exception if type of request or response not recognized

      • closeParser

        public void closeParser()
                 throws java.lang.Exception
        Closes the parser
        Specified by:
        closeParser in interface ParserInterface
        Overrides:
        closeParser in class ParserImpl
        Throws:
        java.lang.Exception - Throws exception if closing fails

      • getSingleNode

        public org.w3c.dom.Node getSingleNode()
        Retrieves inner node from the output xml document.
        Returns:
        the last node.

      • getSearchResultEntry

        public static com.ibm.ldap.dsml.SearchResultEntry getSearchResultEntry​(Entry aEntry)
        Retrieves single search result only.
        Parameters:
        aEntry - the entry from which to retrieve single search result.
        Returns:
        SearchResultEntry object

      • getSearchResultDoneFromEntry

        public static com.ibm.ldap.dsml.LdapResult getSearchResultDoneFromEntry​(Entry aEntry)
        Retrieves search result done.
        Parameters:
        aEntry - the entry from which to retrieve search result.
        Returns:
        LDAP result

      • getVersion

        public java.lang.String getVersion()
        Version information.
        Returns:
        version information.

      • xmlNodeToString

        public java.lang.String xmlNodeToString​(org.w3c.dom.Node aNode,
                                        boolean aIndentOutput)
                                 throws java.lang.Exception
        Gives meaningful string representation of a XML node.
        Parameters:
        aNode - the Node object.
        aIndentOutput - if true the output will be indented.
        Returns:
        String object
        Throws:
        java.lang.Exception - If an unrecoverable error occurs during the course of the transformation.

      • dsmlMessageToElement

        public static org.w3c.dom.Element dsmlMessageToElement​(com.ibm.ldap.dsml.DsmlMessage aDsmlMessage)
                                                throws java.lang.Exception
        Converts DSML message to Element.
        Parameters:
        aDsmlMessage - the DSML message.
        Returns:
        Element object
        Throws:
        java.lang.Exception - if a DocumentBuilder cannot be created which satisfies the configuration requested.