Package com.aducid.sdk

Class AbstractAducidClient

java.lang.Object
com.aducid.sdk.AbstractAducidClient
Direct Known Subclasses:
AducidClient
public abstract class AbstractAducidClient
extends java.lang.Object
Abstract client for accessing ADUCID operations. Created 11. 4. 2018 9:59:11
Author:
Radek Jira

  • Constructor Summary

    Constructors 
    Constructor Description
    AbstractAducidClient​(java.lang.String aimUrl)
    Constructor with AIM R4 service URL.
    AbstractAducidClient​(java.lang.String aimUrl, AducidMessageSender messageSender)
    Constructor with AIM R4 service URL and message sender.

  • Method Summary

    Modifier and Type Method Description
    com.aducid.iface.AIMexecutePersonalObjectResponse callDPO​(byte[] authId, byte[] authKey, MethodName methodName, com.aducid.iface.PersonalObjectType personalObject)
    Performs operation on directory personal object.
    com.aducid.iface.AIMrequestOperationResponse callOperation​(OperationName operationName, MethodName methodName, java.util.List<com.aducid.iface.MethodParameterType> methodParameterList, com.aducid.iface.PersonalObjectType personalObject, RequestOperationArguments arguments)
    Calls operation.
    com.aducid.iface.AIMrequestOperationResponse callPPO​(MethodName methodName, java.util.List<com.aducid.iface.MethodParameterType> methodParameterList, com.aducid.iface.PersonalObjectType personalObject, RequestOperationArguments arguments)
    Performs operation on pocket personal object.
    com.aducid.iface.AIMrequestOperationResponse change​(RequestOperationArguments arguments)
    Performs identity change operation.
    com.aducid.iface.AIMrequestOperationResponse delete​(RequestOperationArguments arguments)
    Performs identity delete operation.
    com.aducid.iface.AIMcloseSessionResponse endAuthenticationSession​(byte[] authId, byte[] authKey)
    Ends authentication session.
    java.lang.String getAimUrl()
    Returns AIM R4 service URL.
    com.aducid.iface.AIMgetPSLAttributesResponse getResult​(byte[] authId, byte[] authKey, AttributeSetName attributeSetName)
    Returns result of previous authentication operation.
    com.aducid.iface.AIMgetPSLAttributesResponse getResult​(byte[] authId, byte[] authKey, AttributeSetName attributeSetName, java.lang.String offLineLoginName, java.lang.String offLinePassword, java.lang.String offLineLoginWord)
    Returns result of previous authentication operation.
    com.aducid.iface.AIMrequestOperationResponse init​(RequestOperationArguments arguments)
    Performs identity initialization.
    com.aducid.iface.AIMrequestOperationResponse rechange​(RequestOperationArguments arguments)
    Performs identity re-change operation.
    com.aducid.iface.AIMrequestOperationResponse reinit​(RequestOperationArguments arguments)
    Performs identity re-initialization operation.
    com.aducid.iface.AIMrequestOperationResponse startAuthenticationSession​(RequestOperationArguments arguments)
    Starts authentication session.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AbstractAducidClient

      public AbstractAducidClient​(java.lang.String aimUrl)
      Constructor with AIM R4 service URL.
      Parameters:
      aimUrl - AIM R4 service URL

    • AbstractAducidClient

      public AbstractAducidClient​(java.lang.String aimUrl, AducidMessageSender messageSender)
      Constructor with AIM R4 service URL and message sender.
      Parameters:
      aimUrl - AIM R4 service URL
      messageSender - message sender

  • Method Details

    • getAimUrl

      public java.lang.String getAimUrl()

      Returns AIM R4 service URL.

      Returns:
      AIM R4 service URL

    • startAuthenticationSession

      public com.aducid.iface.AIMrequestOperationResponse startAuthenticationSession​(RequestOperationArguments arguments) throws AducidClientException
      Starts authentication session.
      Parameters:
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • endAuthenticationSession

      public com.aducid.iface.AIMcloseSessionResponse endAuthenticationSession​(byte[] authId, byte[] authKey) throws AducidClientException
      Ends authentication session.
      Parameters:
      authId - authId
      authKey - authKey
      Returns:
      close session response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • init

      public com.aducid.iface.AIMrequestOperationResponse init​(RequestOperationArguments arguments) throws AducidClientException
      Performs identity initialization.
      Parameters:
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • reinit

      public com.aducid.iface.AIMrequestOperationResponse reinit​(RequestOperationArguments arguments) throws AducidClientException
      Performs identity re-initialization operation.
      Parameters:
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • change

      public com.aducid.iface.AIMrequestOperationResponse change​(RequestOperationArguments arguments) throws AducidClientException
      Performs identity change operation.
      Parameters:
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • rechange

      public com.aducid.iface.AIMrequestOperationResponse rechange​(RequestOperationArguments arguments) throws AducidClientException
      Performs identity re-change operation.
      Parameters:
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • delete

      public com.aducid.iface.AIMrequestOperationResponse delete​(RequestOperationArguments arguments) throws AducidClientException
      Performs identity delete operation.
      Parameters:
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • callPPO

      public com.aducid.iface.AIMrequestOperationResponse callPPO​(MethodName methodName, java.util.List<com.aducid.iface.MethodParameterType> methodParameterList, com.aducid.iface.PersonalObjectType personalObject, RequestOperationArguments arguments) throws AducidClientException
      Performs operation on pocket personal object.
      Parameters:
      methodName - method name
      methodParameterList - method parameter list
      personalObject - personal object
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • callDPO

      public com.aducid.iface.AIMexecutePersonalObjectResponse callDPO​(byte[] authId, byte[] authKey, MethodName methodName, com.aducid.iface.PersonalObjectType personalObject) throws AducidClientException
      Performs operation on directory personal object.
      Parameters:
      authId - authentication identifier
      authKey - authentication key
      methodName - method name
      personalObject - personal object
      Returns:
      execute personal object response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getResult

      public com.aducid.iface.AIMgetPSLAttributesResponse getResult​(byte[] authId, byte[] authKey, AttributeSetName attributeSetName) throws AducidClientException
      Returns result of previous authentication operation.
      Parameters:
      authId - authId
      authKey - authKey
      attributeSetName - attribute set name
      Returns:
      get PSL attributes response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getResult

      public com.aducid.iface.AIMgetPSLAttributesResponse getResult​(byte[] authId, byte[] authKey, AttributeSetName attributeSetName, java.lang.String offLineLoginName, java.lang.String offLinePassword, java.lang.String offLineLoginWord) throws AducidClientException
      Returns result of previous authentication operation.
      Parameters:
      authId - authId
      authKey - authKey
      attributeSetName - attribute set name
      offLineLoginName - off line login name
      offLinePassword - off line password
      offLineLoginWord - off line login word
      Returns:
      get PSL attributes response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • callOperation

      public com.aducid.iface.AIMrequestOperationResponse callOperation​(OperationName operationName, MethodName methodName, java.util.List<com.aducid.iface.MethodParameterType> methodParameterList, com.aducid.iface.PersonalObjectType personalObject, RequestOperationArguments arguments) throws AducidClientException
      Calls operation.
      Parameters:
      operationName - operation name
      methodName - method name
      methodParameterList - method parameter list
      personalObject - personal object
      arguments - request operation arguments
      Returns:
      request operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call