Package com.aducid.sdk

Class AducidAdvancedClient

java.lang.Object
com.aducid.sdk.AducidAdvancedClient
public class AducidAdvancedClient
extends java.lang.Object

Client for accessing ADUCID basic and advanced operations. Please choose chapter you are interested in:

Proofing Scenarios

Chapter describes basic implemented proofing scenarios.

By Code

It is used to approve user by code. There are two parts - user and administrator. Proofing scenario is started by administrator.

Administrator

Administrator logins to application and fills registration data. On form submit these methods are called:

See "ADUCID Proofing - Code Admin" application for method call example.

User

User logins to application and fills activation code. On form submit these methods are called:

See "ADUCID Proofing - Code User" application for method call example.

By Form

It is used to approve user by form. There are two parts - user and administrator. Proofing scenario is started by user.

User

User logins to application and fills registration data. On form submit these methods are called:

See "ADUCID Proofing - Form User" application for method call example.

Administrator

Administrator logins to application and fills form identifier. On form submit these methods are called:

See "ADUCID Proofing - Form Admin" application for method call example.

By QR Code

It is used to approve user by taking QR code photo. Proofing scenario is started by administrator. At first administrator logins to application and fills registration data. Then user takes QR code photo and administrator confirms verification icon. Sub-scenario consists of methods:

  • verification - starts verification operation with parameters:
    • VerificationType.PRIMARY - user, whose PEIG shows QR code (administrator here), also confirms verification icon
    • SLFOperation.INIT - if not null, user, who takes QR code photo (user here), must verify his local factor, if local factor does not exist, new one is initiated
  • now QR code is shown on administrator's PEIG, user takes photo, administrator confirms icon and user verifies/initiates his local factor, if required
  • administrator is redirected to peigReturnName URL, which was provided on verification operation start, then methods below are called:

See "ADUCID Proofing - QR Admin" application for method call example.

It is used to approve user by identity link - user connects to other AIM server (identity provider), checks proofing information and copies user profile to current AIM. Proofing requires predefined identity link providers. Providers are handled in "ADUCID Security Administration" application. When providers are ready, user logins to proofing application and methods below are called:

  • readTrustedAimSpids - reads list of predefined identity providers
  • user sees list of provider names, he selects one to be used for identity link
  • identityLinkWithInitLF - starts identity link operation with local factor initialization and identity provider URL as parameter
  • now communication between PEIG and both AIM servers starts, after operation finish methods below are called:

See "ADUCID Proofing - Identity Link" application for method call example.

Other Useful Methods

There are other methods supporting proofing:

Methods Overview

Basic Operations

Chapter describes:

  • Operation Starters, as methods to request identity operation, working with identity life-cycle, identity backup, message verification and verification by QR code
  • Operation Result Evaluators, as methods to evaluate operation result, evaluating request operation success/failure
  • Authentication Session Closer, as method to close authentication session
  • Other Useful Methods, as methods helping operation run/AIM configuration information/PEIG type/proofing status gathering and QR code picture generator

Operation Starters

Chapter describes operations starters. Methods are described below:

All operations internally work with request operation result, which is provided by method below:

Operation Result Evaluators

Chapter describes operation result evaluators. Methods are used to evaluate operation result and verify authentication key. One of methods below must be called to successfully finish request operation:

Remember, authentication key is not mandatory in all AIM supported binding modes as result evaluator input. Just set authentication key optional and result evaluator will decide if authentication key is required, or not, depending on AIM binding mode. All result evaluators returns GetPSLAttributesResponse object as result. To call advanced methods, that require authentication identifier and authentication key on input, you must use authentication key, which is part of that response - GetPSLAttributesResponse.getAuthKey() method.

If you want to evaluate local factor value stand-alone, you can use method below:

  • getLFResult - parses operation result and checks local factor value

Authentication Session Closer

Chapter describes only one method, which is used to close authentication session. This method should be called, when user logs out of your application. Method is:

Other Useful Methods

Chapter describes other useful methods, which helps to gather information about operation run/AIM configuration/PEIG type/proofing status and helps to generate QR code picture. Methods are described below:

  • getSimpleClient - returns native R4 client instance (for ADUCID masters only)
  • getRefreshTimeout - reads refresh timeout, as the AIM REFRESH_TIMEOUT configuration value
  • getPeigDetectionTimeout - reads PEIG detection timeout, as the AIM PEIG_DETECTION_TIMEOUT configuration value
  • getStatus - reads current running operation status, useful, when you want to react on current operation status
  • getPeigReturnName - reads current running operation PEIG return name (return URL), useful, when you want to know URL, where user is redirected to after operation finish
  • getError - reads current running operation error, useful, when you want to throw exception as reaction on error status

Advanced Operations

Chapter describes operations, which can be called after successful login. To invoke any of advanced methods you must know authId and authKey values. Method described in Proofing Scenarios chapter are not mentioned here. This chapter has subchapters:

User Operations

Chapter describes methods, which can be directly called by authenticated user without requirements to have any of administrator roles. If you are interested in basic identity operations or backup methods, see Operation Starters chapter.

Information Readers
PEIG Management
Identity link management

User Administration Operations

Chapter describes methods, which are accessed to authorized user administrator only.

Information Readers
PEIG Management
Identity link management

Security Administration Operations

Chapter describes methods, which are accessed to authorized security administrator only.

Security Profile Readers
Security Profile Writers
Security Operations
Trusted AIM
Home Trusted AIM
Signed AIM

Notes

Factor Naming Convention

Client uses two different names for factor:

  • local factor - more general name, used as product internal name (names of methods, attributes, parameters and constants)
  • personal factor - more particular name, used as public visible name (parameters of R4 methods and configuration, error messages)

You can see both factor names in different technical client scopes.

Created 7. 9. 2015 15:11:12

Author:
Radek Jira

  • Constructor Details

  • Method Details

    • startAuthenticationSession

      public RequestOperationResult startAuthenticationSession​(RequestOperationArguments arguments) throws AducidClientException

      Starts authentication session.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • init

      public RequestOperationResult init​(RequestOperationArguments arguments) throws AducidClientException

      Performs identity initialization.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • reinit

      public RequestOperationResult reinit​(RequestOperationArguments arguments) throws AducidClientException

      Performs identity re-initialization operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • change

      public RequestOperationResult change​(RequestOperationArguments arguments) throws AducidClientException

      Performs identity change operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • rechange

      public RequestOperationResult rechange​(RequestOperationArguments arguments) throws AducidClientException

      Performs identity re-change operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • delete

      public RequestOperationResult delete​(RequestOperationArguments arguments) throws AducidClientException

      Performs identity delete operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • verifyLF

      public RequestOperationResult verifyLF​(RequestOperationArguments arguments) throws AducidClientException

      Performs local factor verification operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • verifyCF

      public RequestOperationResult verifyCF​(RequestOperationArguments arguments) throws AducidClientException

      Performs comfort factor verification operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • localLinkPrimary

      public RequestOperationResult localLinkPrimary​(RequestOperationArguments arguments) throws AducidClientException

      Performs primary local link operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • localLinkSecondary

      public RequestOperationResult localLinkSecondary​(RequestOperationArguments arguments) throws AducidClientException

      Performs secondary local link operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • localLinkConnection

      public RequestOperationResult localLinkConnection​(RequestOperationArguments arguments) throws AducidClientException

      Performs connection local link operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • meetingRoomCreate

      public RequestOperationResult meetingRoomCreate​(RequestOperationArguments arguments) throws AducidClientException

      Performs meeting room create operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • meetingRoomEnter

      public RequestOperationResult meetingRoomEnter​(RequestOperationArguments arguments) throws AducidClientException

      Performs meeting room enter operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • verifyMessage

      public RequestOperationResult verifyMessage​(java.lang.String peigMessage, RequestOperationArguments arguments) throws AducidClientException

      Performs verify message operation.

      Parameters:
      peigMessage - PEIG message
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • verifyMessageWithLF

      public RequestOperationResult verifyMessageWithLF​(java.lang.String peigMessage, RequestOperationArguments arguments) throws AducidClientException

      Performs verify message operation with local factor.

      Parameters:
      peigMessage - PEIG message
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • verifyMessageWithCF

      public RequestOperationResult verifyMessageWithCF​(java.lang.String peigMessage, RequestOperationArguments arguments) throws AducidClientException

      Performs verify message operation with comfort factor.

      Parameters:
      peigMessage - PEIG message
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • verification

      public RequestOperationResult verification​(VerificationType verificationType, PLFOperation plfOperation, SLFOperation slfOperation, RequestOperationArguments arguments) throws AducidClientException

      Performs verification operation.

      Parameters:
      verificationType - verification type
      plfOperation - primary local factor operation
      slfOperation - secondary local factor operation
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • identityLink

      public RequestOperationResult identityLink​(java.util.List<java.lang.String> remoteAims, java.lang.String peigMessage, java.lang.String peigMessageData, RequestOperationArguments arguments) throws AducidClientException

      Performs identity link operation.

      Parameters:
      remoteAims - list of remote AIMs
      peigMessage - PEIG message
      peigMessageData - PEIG message data
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • identityLinkWithInitLF

      public RequestOperationResult identityLinkWithInitLF​(java.util.List<java.lang.String> remoteAims, java.lang.String peigMessage, java.lang.String peigMessageData, RequestOperationArguments arguments) throws AducidClientException

      Performs identity link operation with local factor initialization.

      Parameters:
      remoteAims - list of remote AIMs
      peigMessage - PEIG message
      peigMessageData - PEIG message data
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deleteIdentityLink

      public RequestOperationResult deleteIdentityLink​(java.util.List<java.lang.String> remoteAims, RequestOperationArguments arguments) throws AducidClientException

      Performs identity link deletion operation.

      Parameters:
      remoteAims - list of remote AIMs
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • oneTimeLink

      public RequestOperationResult oneTimeLink​(java.util.List<java.lang.String> remoteAims, java.lang.String peigMessage, java.lang.String peigMessageData, RequestOperationArguments arguments) throws AducidClientException

      Performs one time link operation.

      Parameters:
      remoteAims - list of remote AIMs
      peigMessage - PEIG message
      peigMessageData - PEIG message data
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • oneTimeLinkWithLF

      public RequestOperationResult oneTimeLinkWithLF​(java.util.List<java.lang.String> remoteAims, java.lang.String peigMessage, java.lang.String peigMessageData, RequestOperationArguments arguments) throws AducidClientException

      Performs one time link operation with local factor.

      Parameters:
      remoteAims - list of remote AIMs
      peigMessage - PEIG message
      peigMessageData - PEIG message data
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • oneTimeLinkWithCF

      public RequestOperationResult oneTimeLinkWithCF​(java.util.List<java.lang.String> remoteAims, java.lang.String peigMessage, java.lang.String peigMessageData, RequestOperationArguments arguments) throws AducidClientException

      Performs one time link operation with comfort factor.

      Parameters:
      remoteAims - list of remote AIMs
      peigMessage - PEIG message
      peigMessageData - PEIG message data
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • oneTimeLinkWithInitLF

      public RequestOperationResult oneTimeLinkWithInitLF​(java.util.List<java.lang.String> remoteAims, java.lang.String peigMessage, java.lang.String peigMessageData, RequestOperationArguments arguments) throws AducidClientException

      Performs one time link operation with local factor initialization.

      Parameters:
      remoteAims - list of remote AIMs
      peigMessage - PEIG message
      peigMessageData - PEIG message data
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • initEncryptionKeys

      public RequestOperationResult initEncryptionKeys​(java.lang.Integer keyBufferLength, java.lang.Integer keyLength, RequestOperationArguments arguments) throws AducidClientException

      Performs encryption keys initialization operation.

      Parameters:
      keyBufferLength - key buffer length
      keyLength - key length
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • refreshEncryptionKeys

      public RequestOperationResult refreshEncryptionKeys​(RequestOperationArguments arguments) throws AducidClientException

      Performs encryption keys refresh operation.

      Parameters:
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • authenticatedEncrypt

      public RequestOperationResult authenticatedEncrypt​(java.util.List<java.lang.String> targetUdis, RequestOperationArguments arguments) throws AducidClientException

      Performs authenticated encryption operation.

      Parameters:
      targetUdis - list of target UDIs
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • authenticatedEncryptWithLF

      public RequestOperationResult authenticatedEncryptWithLF​(java.util.List<java.lang.String> targetUdis, RequestOperationArguments arguments) throws AducidClientException

      Performs authenticated encryption operation with local factor.

      Parameters:
      targetUdis - list of target UDIs
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • authenticatedDecrypt

      public RequestOperationResult authenticatedDecrypt​(java.lang.String eventId, RequestOperationArguments arguments) throws AducidClientException

      Performs authenticated decryption operation.

      Parameters:
      eventId - event identifier
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • authenticatedDecryptWithLF

      public RequestOperationResult authenticatedDecryptWithLF​(java.lang.String eventId, RequestOperationArguments arguments) throws AducidClientException

      Performs authenticated decryption operation with local factor.

      Parameters:
      eventId - event identifier
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • authenticatedReadKey

      public RequestOperationResult authenticatedReadKey​(java.lang.String keyId, RequestOperationArguments arguments) throws AducidClientException

      Performs authenticated read key operation.

      Parameters:
      keyId - key identifier
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • authenticatedReadKeyWithLF

      public RequestOperationResult authenticatedReadKeyWithLF​(java.lang.String keyId, RequestOperationArguments arguments) throws AducidClientException

      Performs authenticated read key operation with local factor.

      Parameters:
      keyId - key identifier
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • endAuthenticationSession

      public CloseSessionResponse endAuthenticationSession​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Ends authentication session.

      Parameters:
      authId - authId
      authKey - authKey
      Returns:
      close session response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSecurityOperationStatus

      public SecurityOperationStatus readSecurityOperationStatus​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads security operation status.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      security operation status
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • enforceChange

      public void enforceChange​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Enforces identity change.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • suppressAnticopy

      public void suppressAnticopy​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Suppresses identity anticopy.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSecurityProfiles

      public SearchResult readSecurityProfiles​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads all security profiles.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with security profiles
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSecurityProfileDetails

      public SecurityProfile readSecurityProfileDetails​(java.lang.String authId, java.lang.String authKey, java.lang.String profileName) throws AducidClientException

      Reads security profile details.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      profileName - security profile name
      Returns:
      security profile details
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSecurityProfileTemplateNames

      public java.util.List<java.lang.String> readSecurityProfileTemplateNames​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads all security profile template names.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of template names
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSecurityProfileTemplate

      public SecurityProfile readSecurityProfileTemplate​(java.lang.String authId, java.lang.String authKey, java.lang.String profileTemplate) throws AducidClientException

      Reads security profile template.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      profileTemplate - profile template
      Returns:
      security profile
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSecurityProfilePrioritiesImage

      public byte[] readSecurityProfilePrioritiesImage​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads security profile priorities image.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      priorities image as byte array
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • securityProfileExists

      public java.lang.Boolean securityProfileExists​(java.lang.String authId, java.lang.String authKey, java.lang.String profileName) throws AducidClientException

      Tests, if security profile exists.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      profileName - profile name
      Returns:
      true, if security profile exists
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • createSecurityProfile

      public void createSecurityProfile​(java.lang.String authId, java.lang.String authKey, SecurityProfile securityProfile) throws AducidClientException

      Creates security profile.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      securityProfile - security profile
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • updateSecurityProfile

      public void updateSecurityProfile​(java.lang.String authId, java.lang.String authKey, SecurityProfile securityProfile) throws AducidClientException

      Updates security profile.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      securityProfile - security profile
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • updateSecurityProfilePriority

      public void updateSecurityProfilePriority​(java.lang.String authId, java.lang.String authKey, java.lang.String profileName, java.lang.String profilePriority) throws AducidClientException

      Updates security profile priority.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      profileName - security profile name
      profilePriority - security profile priority
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deleteSecurityProfile

      public void deleteSecurityProfile​(java.lang.String authId, java.lang.String authKey, java.lang.String profileName) throws AducidClientException

      Deletes security profile.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      profileName - profile name
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readTrustedAims

      public java.util.List<TrustedAim> readTrustedAims​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads list of trusted AIMs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of trusted AIMs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readMessageStatistics

      public MessageStatistics readMessageStatistics​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads message statistics.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      message statistics
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • createTrustedAim

      public void createTrustedAim​(java.lang.String authId, java.lang.String authKey, TrustedAim trustedAim) throws AducidClientException

      Creates trusted AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      trustedAim - trusted AIM
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deleteTrustedAim

      public void deleteTrustedAim​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Deletes trusted AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • uploadTrustedAimCertificate

      public void uploadTrustedAimCertificate​(java.lang.String authId, java.lang.String authKey, java.lang.String spid, java.lang.String certificate) throws AducidClientException

      Uploads trusted AIM certificate.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      certificate - certificate
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • pingRemoteAim

      public PingResult pingRemoteAim​(java.lang.String authId, java.lang.String authKey, java.lang.String remoteAim, java.lang.String request) throws AducidClientException

      Ping remote AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      remoteAim - remote AIM
      request - request
      Returns:
      ping result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • enableTrust

      public void enableTrust​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Enables trust.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • disableTrust

      public void disableTrust​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Disables trust.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • enableSignatureVerification

      public void enableSignatureVerification​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Enables signature verification.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • disableSignatureVerification

      public void disableSignatureVerification​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Disables signature verification.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readHomeTrustedAims

      public java.util.List<HomeTrustedAim> readHomeTrustedAims​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads list of home trusted AIMs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of home trusted AIMs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • createHomeTrustedAim

      public void createHomeTrustedAim​(java.lang.String authId, java.lang.String authKey, java.lang.String spid, java.lang.String certificate) throws AducidClientException

      Creates home trusted AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      certificate - certificate
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • updateHomeTrustedAim

      public void updateHomeTrustedAim​(java.lang.String authId, java.lang.String authKey, HomeTrustedAim homeTrustedAim) throws AducidClientException

      Updates home trusted AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      homeTrustedAim - home trusted AIM
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deleteHomeTrustedAim

      public void deleteHomeTrustedAim​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Deletes home trusted AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readSignedAims

      public java.util.List<SignedAim> readSignedAims​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads list of signed AIMs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of signed AIMs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • createSignedAim

      public void createSignedAim​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Creates signed AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deleteSignedAim

      public void deleteSignedAim​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Deletes signed AIM.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • enableSign

      public void enableSign​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Enables sign.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • disableSign

      public void disableSign​(java.lang.String authId, java.lang.String authKey, java.lang.String spid) throws AducidClientException

      Disables sign.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      spid - SPID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readTlsCertificates

      public java.util.List<TlsCertificate> readTlsCertificates​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads list of TLS certificates.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of TLS certificates
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • certIdExists

      public java.lang.Boolean certIdExists​(java.lang.String authId, java.lang.String authKey, java.lang.String certId) throws AducidClientException

      Tests, if certificate identifier exists.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      certId - certificate identifier
      Returns:
      true, if certificate identifier exists
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • createTlsCertificate

      public void createTlsCertificate​(java.lang.String authId, java.lang.String authKey, java.lang.String certId, java.lang.String certificate) throws AducidClientException

      Creates TLS certificate.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      certId - certificate identifier
      certificate - certificate
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • updateTlsCertificate

      public void updateTlsCertificate​(java.lang.String authId, java.lang.String authKey, java.lang.String certId, java.lang.String certificate) throws AducidClientException

      Updates TLS certificate.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      certId - certificate identifier
      certificate - certificate
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deleteTlsCertificate

      public void deleteTlsCertificate​(java.lang.String authId, java.lang.String authKey, java.lang.String certId) throws AducidClientException

      Deletes TLS certificate.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      certId - certificate identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • enableEnforcement

      public void enableEnforcement​(java.lang.String authId, java.lang.String authKey, java.lang.String certId) throws AducidClientException

      Enables enforcement.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      certId - certificate identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • disableEnforcement

      public void disableEnforcement​(java.lang.String authId, java.lang.String authKey, java.lang.String certId) throws AducidClientException

      Disables enforcement.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      certId - certificate identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • generateUdi

      public java.lang.String generateUdi​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Generates UDI.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      generated UDI
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • udiExists

      public java.lang.Boolean udiExists​(java.lang.String authId, java.lang.String authKey, java.lang.String udi) throws AducidClientException

      Tests, if UDI exists.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      Returns:
      true, if UDI exists
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • udiDeleted

      public java.lang.Boolean udiDeleted​(java.lang.String authId, java.lang.String authKey, java.lang.String udi) throws AducidClientException

      Tests, if UDI is deleted.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      Returns:
      true, if UDI is deleted
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readUdis

      public SearchResult readUdis​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads UDIs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with UDIs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readAllEvents

      public SearchResult readAllEvents​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads all events.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with all events
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readEventsByAdmin

      public SearchResult readEventsByAdmin​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads events by admin.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with user events
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readEventStatistics

      public SearchResult readEventStatistics​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads event statistics.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with event statistics
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readStatistics

      public SearchResult readStatistics​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads statistics.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with statistics
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readOtherPeigsId

      public java.util.List<Peig> readOtherPeigsId​(java.lang.String authId, java.lang.String authKey, java.lang.String udi) throws AducidClientException

      Reads information about other PEIGs ID.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      Returns:
      list of other PEIGs ID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • activateOtherPeig

      public void activateOtherPeig​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, java.lang.String peigId) throws AducidClientException

      Activates other PEIG.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deactivateOtherPeig

      public void deactivateOtherPeig​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, java.lang.String peigId) throws AducidClientException

      Deactivates other PEIG.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • revokeOtherPeig

      public void revokeOtherPeig​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, java.lang.String peigId) throws AducidClientException

      Revokes other PEIG.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • listOthersLinkedAims

      public java.util.List<java.lang.String> listOthersLinkedAims​(java.lang.String authId, java.lang.String authKey, java.lang.String localUdi) throws AducidClientException

      Lists others linked AIMs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      localUdi - local UDI
      Returns:
      list of others linked AIMs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • syncOthersIdentityLinkedUserData

      public SyncResult syncOthersIdentityLinkedUserData​(java.lang.String authId, java.lang.String authKey, java.lang.String remoteAim, java.lang.String request, java.lang.String localUdi) throws AducidClientException

      Synchronizes others identity linked user data.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      remoteAim - remote AIM
      request - request
      localUdi - local UDI
      Returns:
      sync result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • syncOthersOneTimeLinkedUserData

      public SyncResult syncOthersOneTimeLinkedUserData​(java.lang.String authId, java.lang.String authKey, java.lang.String remoteAim, java.lang.String request, java.lang.String localUdi) throws AducidClientException

      Synchronizes others one time linked user data.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      remoteAim - remote AIM
      request - request
      localUdi - local UDI
      Returns:
      sync result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • setApprovedOthersUdi

      public void setApprovedOthersUdi​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, java.lang.String peigId) throws AducidClientException

      Sets approved others UDI.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readData

      public java.lang.String readData​(java.lang.String authId, java.lang.String authKey, java.lang.String udi) throws AducidClientException

      Reads data.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      Returns:
      data
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • writeData

      public void writeData​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, java.lang.String data) throws AducidClientException

      Writes data.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      data - data
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readRoles

      public java.lang.String readRoles​(java.lang.String authId, java.lang.String authKey, java.lang.String udi) throws AducidClientException

      Reads roles.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      Returns:
      roles
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • writeRoles

      public void writeRoles​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, java.lang.String roles) throws AducidClientException

      Writes roles.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      roles - roles
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • writeProofingRoles

      public void writeProofingRoles​(java.lang.String authId, java.lang.String authKey, java.lang.String udi, ProofingStatus proofingStatus, ProofingType proofingType, PeigType peigType) throws AducidClientException

      Writes proofing roles.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      proofingStatus - proofing status
      proofingType - proofing type
      peigType - PEIG type
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readAimAttributes

      public AimAttributes readAimAttributes​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads AIM attributes.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      AIM attributes
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readEvents

      public SearchResult readEvents​(java.lang.String authId, java.lang.String authKey, SearchFilter searchFilter) throws AducidClientException

      Reads events.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      searchFilter - search filter
      Returns:
      search result with events
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readMyPeigsId

      public java.util.List<Peig> readMyPeigsId​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads information about my PEIGs ID.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of my PEIGs ID
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • activateMyPeig

      public void activateMyPeig​(java.lang.String authId, java.lang.String authKey, java.lang.String peigId) throws AducidClientException

      Activates my PEIG.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • deactivateMyPeig

      public void deactivateMyPeig​(java.lang.String authId, java.lang.String authKey, java.lang.String peigId) throws AducidClientException

      Deactivates my PEIG.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • revokeMyPeig

      public void revokeMyPeig​(java.lang.String authId, java.lang.String authKey, java.lang.String peigId) throws AducidClientException

      Revokes my PEIG.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      peigId - PEIG identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • readTrustedAimSpids

      public java.util.List<java.lang.String> readTrustedAimSpids​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Reads list of trusted AIM SPIDs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of trusted AIM SPIDs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • listMyLinkedAims

      public java.util.List<java.lang.String> listMyLinkedAims​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Lists my linked AIMs.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      list of my linked AIMs
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • syncMyIdentityLinkedUserData

      public SyncResult syncMyIdentityLinkedUserData​(java.lang.String authId, java.lang.String authKey, java.lang.String remoteAim, java.lang.String request, java.lang.String pairedUdi) throws AducidClientException

      Synchronizes my identity linked user data.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      remoteAim - remote AIM
      request - request
      pairedUdi - paired UDI
      Returns:
      sync result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • syncMyOneTimeLinkedUserData

      public SyncResult syncMyOneTimeLinkedUserData​(java.lang.String authId, java.lang.String authKey, java.lang.String remoteAim, java.lang.String request) throws AducidClientException

      Synchronizes my one time linked user data.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      remoteAim - remote AIM
      request - request
      Returns:
      sync result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • setApprovedMyUdi

      public void setApprovedMyUdi​(java.lang.String authId, java.lang.String authKey, java.lang.String udi) throws AducidClientException

      Sets approved my UDI.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      udi - UDI
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getSimpleClient

      public AducidClient getSimpleClient()

      Returns simple client instance.

      Returns:
      simple client

    • getRefreshTimeout

      public java.lang.Integer getRefreshTimeout() throws AducidClientException

      Asks AIM server for REFRESH_TIMEOUT configuration value.

      Returns:
      REFRESH_TIMEOUT configuration value
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getPeigDetectionTimeout

      public java.lang.Integer getPeigDetectionTimeout() throws AducidClientException

      Asks AIM server for PEIG_DETECTION_TIMEOUT configuration value.

      Returns:
      PEIG_DETECTION_TIMEOUT configuration value
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getPushSendTimeout

      public java.lang.Integer getPushSendTimeout() throws AducidClientException

      Asks AIM server for PUSH_SEND_TIMEOUT configuration value.

      Returns:
      PUSH_SEND_TIMEOUT configuration value
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getStatus

      public AIMStatus getStatus​(java.lang.String authId) throws AducidClientException

      Asks AIM server for current running operation status - R4 getPSLAttributes method call with attribute set name "Status".

      Parameters:
      authId - authentication identifier
      Returns:
      AIM status
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getPeigReturnName

      public java.lang.String getPeigReturnName​(java.lang.String authId) throws AducidClientException

      Asks AIM server for current running operation PEIG return name (return URL) - R4 getPSLAttributes method call with attribute set name "PeigReturnName".

      Parameters:
      authId - authentication identifier
      Returns:
      PEIG return name
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getError

      public void getError​(java.lang.String authId) throws AducidClientException

      Asks AIM server for current running operation error - R4 getPSLAttributes method call with attribute set name "Error".

      Parameters:
      authId - authentication identifier
      Throws:
      AducidClientException - when error occurs during ADUCID client call or as method result

    • getResult

      public GetPSLAttributesResponse getResult​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Evaluates operation result. Basic method, which should be used in all scenarios except of:

      It is good to know method logic partial steps:

      • Method asks for operation result (R4 getPSLAttributes method call with attribute set name "All")
      • If operation result is unsuccessful (AIM status equals to "Auth-error"), method asks for error detail (R4 getPSLAttributes method call with attribute set name "Error") and throws exception
      • If operation result is successful (AIM status equals to "active" and authentication status equals to "OK"), these steps are done:
        • If authKey2 was used, this one is used in operation response instead of original authKey
        • If local factor was used and its value differs to "OK", exception is thrown
      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getResultNoLFCheck

      public GetPSLAttributesResponse getResultNoLFCheck​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Evaluates operation result without local factor success check.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getLFResult

      public GetPSLAttributesResponse getLFResult​(GetPSLAttributesResponse response) throws AducidClientException

      Evaluates local factor result from operation response without authentication key verification. If local factor was used, it checks his value. If local factor value differs to "OK", exception is thrown.

      Parameters:
      response - operation response
      Returns:
      modified operation response with verifiedLF flag value set on, if local factor value was "OK"
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getSecondaryLFResult

      public GetPSLAttributesResponse getSecondaryLFResult​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Evaluates secondary local factor result. Method getResult is called before this evaluation start. If secondary local factor was used, it checks his value. If local factor value differs to "OK", exception is thrown.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getSecondaryLFResultNoLFCheck

      public GetPSLAttributesResponse getSecondaryLFResultNoLFCheck​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Evaluates secondary local factor result without primary local factor check. Method getResult is called before this evaluation start. If secondary local factor was used, it checks his value. If local factor value differs to "OK", exception is thrown.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getVerifyMessageResult

      public GetPSLAttributesResponse getVerifyMessageResult​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Evaluates message verification result (result of verifyMessage, verifyMessageWithLF and verifyMessageWithCF operations). Method getResult is called before this evaluation start. If message verification return status differs to "AU", exception is thrown.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getVerificationResult

      public GetPSLAttributesResponse getVerificationResult​(java.lang.String authId, java.lang.String authKey) throws AducidClientException

      Evaluates verification operation result (result of verification operation). Method getSecondaryLFResult is called before this evaluation start. Compares UDI of authenticated session and active UDI of verification operation result. Both UDI must be equal, else exception is thrown.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      Returns:
      operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getRequestOperationResult

      public RequestOperationResult getRequestOperationResult​(com.aducid.iface.AIMrequestOperationResponse response, RequestOperationArguments arguments) throws AducidClientException

      Returns request operation result.

      Parameters:
      response - request operation response
      arguments - request operation arguments
      Returns:
      request operation result
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • toJson

      public java.lang.String toJson​(java.lang.Object data, java.lang.String redirect)

      Converts data to JSON.

      Parameters:
      data - data
      redirect - redirect
      Returns:
      data as JSON

    • toErrorJson

      public java.lang.String toErrorJson​(ErrorResult errorResult, java.lang.String redirect)

      Converts error result to error JSON.

      Parameters:
      errorResult - error result
      redirect - redirect
      Returns:
      exception as error JSON

    • setSimpleClient

      protected void setSimpleClient​(AducidClient simpleClient)

      Sets simple client.

      Parameters:
      simpleClient - simple client

    • callDPO

      protected com.aducid.iface.AIMexecutePersonalObjectResponse callDPO​(java.lang.String authId, java.lang.String authKey, MethodName methodName) throws AducidClientException

      Calls directory personal object operation.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      methodName - method name
      Returns:
      directory personal object operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • callDPO

      protected com.aducid.iface.AIMexecutePersonalObjectResponse callDPO​(java.lang.String authId, java.lang.String authKey, MethodName methodName, java.lang.String subjectUdi, java.lang.String peigId) throws AducidClientException

      Calls directory personal object operation.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      methodName - method name
      subjectUdi - subject UDI
      peigId - PEIG identifier
      Returns:
      directory personal object operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • callDPO

      protected com.aducid.iface.AIMexecutePersonalObjectResponse callDPO​(java.lang.String authId, java.lang.String authKey, MethodName methodName, com.aducid.iface.PersonalObjectType personalObject) throws AducidClientException

      Calls directory personal object operation.

      Parameters:
      authId - authentication identifier
      authKey - authentication key
      methodName - method name
      personalObject - personal object
      Returns:
      directory personal object operation response
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getLFResult

      protected GetPSLAttributesResponse getLFResult​(GetPSLAttributesResponse response, boolean throwException) throws AducidClientException

      Evaluates local factor result from operation response without authentication key verification. If local factor was used, it checks his value. If local factor value differs to "OK" and "throwException" flag value is set on, exception is thrown.

      Parameters:
      response - operation response
      throwException - throw exception flag value
      Returns:
      modified operation response with verifiedLF flag value set on, if local factor value was "OK"
      Throws:
      AducidClientException - when error occurs during ADUCID client call

    • getBytes

      protected byte[] getBytes​(java.lang.String string)