io.getlime.security.soap.spring.client

Class PowerAuthServiceClient

java.lang.Object

org.springframework.ws.client.core.support.WebServiceGatewaySupport

io.getlime.security.soap.spring.client.PowerAuthServiceClient

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class PowerAuthServiceClient
extends org.springframework.ws.client.core.support.WebServiceGatewaySupport

Class implementing a PowerAuth SOAP service client based on provided WSDL service description.

Author:

Petr Dvorak

Field Summary

Fields inherited from class org.springframework.ws.client.core.support.WebServiceGatewaySupport

logger

Constructor Summary

Constructors

Constructor and Description
PowerAuthServiceClient()

Method Summary

Modifier and Type	Method and Description
BlockActivationResponse	blockActivation(BlockActivationRequest request) Call the blockActivation method of the PowerAuth 2.0 Server SOAP interface.
BlockActivationResponse	blockActivation(String activationId) Call the blockActivation method of the PowerAuth 2.0 Server SOAP interface.
CommitActivationResponse	commitActivation(CommitActivationRequest request) Call the commitActivation method of the PowerAuth 2.0 Server SOAP interface.
CommitActivationResponse	commitActivation(String activationId) Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.
CreateApplicationResponse	createApplication(CreateApplicationRequest request) Create a new application with given name.
CreateApplicationResponse	createApplication(String name) Create a new application with given name.
CreateApplicationVersionResponse	createApplicationVersion(CreateApplicationVersionRequest request) Create a version with a given name for an application with given ID.
CreateApplicationVersionResponse	createApplicationVersion(Long applicationId, String versionName) Create a version with a given name for an application with given ID.
CreateCallbackUrlResponse	createCallbackUrl(CreateCallbackUrlRequest request) Create a new callback URL with given request object.
CreateCallbackUrlResponse	createCallbackUrl(Long applicationId, String name, String callbackUrl) Create a new callback URL with given parameters.
CreateIntegrationResponse	createIntegration(CreateIntegrationRequest request) Create a new integration with given name.
CreateIntegrationResponse	createIntegration(String name) Create a new integration with given name.
GetEncryptionKeyResponse	generateE2EEncryptionKey(GetEncryptionKeyRequest request) Call the generateE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface.
GetEncryptionKeyResponse	generateE2EEncryptionKey(String activationId) Call the generateE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface and get newly generated derived encryption key.
GetActivationListForUserResponse	getActivationListForUser(GetActivationListForUserRequest request) Call the getActivationListForUser method of the PowerAuth 2.0 Server SOAP interface.
List<GetActivationListForUserResponse.Activations>	getActivationListForUser(String userId) Call the getActivationListForUser method of the PowerAuth 2.0 Server SOAP interface.
GetActivationStatusResponse	getActivationStatus(GetActivationStatusRequest request) Call the getActivationStatus method of the PowerAuth 2.0 Server SOAP interface.
GetActivationStatusResponse	getActivationStatus(String activationId) Call the getActivationStatus method of the PowerAuth 2.0 Server SOAP interface.
GetApplicationDetailResponse	getApplicationDetail(GetApplicationDetailRequest request) Return the detail of given application, including all application versions.
GetApplicationDetailResponse	getApplicationDetail(Long applicationId) Get the detail of an application with given ID, including the version list.
List<GetApplicationListResponse.Applications>	getApplicationList() Get the list of all applications that are registered in PowerAuth 2.0 Server.
GetApplicationListResponse	getApplicationList(GetApplicationListRequest request) Get the list of all applications that are registered in PowerAuth 2.0 Server.
GetCallbackUrlListResponse	getCallbackUrlList(GetCallbackUrlListRequest request) Get the response with list of callback URL objects.
List<GetCallbackUrlListResponse.CallbackUrlList>	getCallbackUrlList(Long applicationId) Get the list of callback URL objects.
List<GetIntegrationListResponse.Items>	getIntegrationList() Get the list of integrations.
GetIntegrationListResponse	getIntegrationList(GetIntegrationListRequest request) Get the list of integrations.
SignatureAuditResponse	getSignatureAuditLog(SignatureAuditRequest request) Call the getSignatureAuditLog method of the PowerAuth 2.0 Server SOAP interface.
List<SignatureAuditResponse.Items>	getSignatureAuditLog(String userId, Date startingDate, Date endingDate) Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface and get signature audit log for all application of a given user.
List<SignatureAuditResponse.Items>	getSignatureAuditLog(String userId, Long applicationId, Date startingDate, Date endingDate) Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface and get signature audit log for a single application.
GetSystemStatusResponse	getSystemStatus() Call the getSystemStatus method of the PowerAuth 2.0 Server SOAP interface.
GetSystemStatusResponse	getSystemStatus(GetSystemStatusRequest request) Call the getSystemStatus method of the PowerAuth 2.0 Server SOAP interface.
InitActivationResponse	initActivation(InitActivationRequest request) Call the initActivation method of the PowerAuth 2.0 Server SOAP interface.
InitActivationResponse	initActivation(String userId, Long applicationId) Call the initActivation method of the PowerAuth 2.0 Server SOAP interface.
InitActivationResponse	initActivation(String userId, Long applicationId, Long maxFailureCount, Date timestampActivationExpire) Call the initActivation method of the PowerAuth 2.0 Server SOAP interface.
PrepareActivationResponse	prepareActivation(PrepareActivationRequest request) Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.
PrepareActivationResponse	prepareActivation(String activationIdShort, String activationName, String activationNonce, String ephemeralPublicKey, String cDevicePublicKey, String extras, String applicationKey, String applicationSignature) Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.
RemoveActivationResponse	removeActivation(RemoveActivationRequest request) Call the removeActivation method of the PowerAuth 2.0 Server SOAP interface.
RemoveActivationResponse	removeActivation(String activationId) Call the removeActivation method of the PowerAuth 2.0 Server SOAP interface.
RemoveCallbackUrlResponse	removeCallbackUrl(RemoveCallbackUrlRequest request) Remove callback URL.
RemoveCallbackUrlResponse	removeCallbackUrl(String callbackUrlId) Remove callback URL.
RemoveIntegrationResponse	removeIntegration(RemoveIntegrationRequest request) Remove integration with given ID.
RemoveIntegrationResponse	removeIntegration(String id) Remove integration with given ID.
SupportApplicationVersionResponse	supportApplicationVersion(Long versionId) Renew the support for a given application version.
SupportApplicationVersionResponse	supportApplicationVersion(SupportApplicationVersionRequest request) Renew the support for a given application version.
UnblockActivationResponse	unblockActivation(String activationId) Call the unblockActivation method of the PowerAuth 2.0 Server SOAP interface.
UnblockActivationResponse	unblockActivation(UnblockActivationRequest request) Call the unblockActivation method of the PowerAuth 2.0 Server SOAP interface.
VaultUnlockResponse	unlockVault(String activationId, String applicationKey, String data, String signature, String signatureType) Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.
VaultUnlockResponse	unlockVault(VaultUnlockRequest request) Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.
UnsupportApplicationVersionResponse	unsupportApplicationVersion(Long versionId) Cancel the support for a given application version.
UnsupportApplicationVersionResponse	unsupportApplicationVersion(UnsupportApplicationVersionRequest request) Cancel the support for a given application version.
VerifyECDSASignatureResponse	verifyECDSASignature(String activationId, String data, String signature) Call the verifyECDSASignature method of the PowerAuth 2.0 Server SOAP interface.
VerifyECDSASignatureResponse	verifyECDSASignature(VerifyECDSASignatureRequest request) Call the verifyECDSASignature method of the PowerAuth 2.0 Server SOAP interface.
VerifySignatureResponse	verifySignature(String activationId, String applicationKey, String data, String signature, String signatureType) Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface.
VerifySignatureResponse	verifySignature(VerifySignatureRequest request) Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface.

Methods inherited from class org.springframework.ws.client.core.support.WebServiceGatewaySupport

afterPropertiesSet, getDefaultUri, getDestinationProvider, getInterceptors, getMarshaller, getMessageFactory, getMessageSenders, getUnmarshaller, getWebServiceTemplate, initGateway, setDefaultUri, setDestinationProvider, setInterceptors, setMarshaller, setMessageFactory, setMessageSender, setMessageSenders, setUnmarshaller, setWebServiceTemplate

Methods inherited from class java.lang.Object

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

Constructor Detail

PowerAuthServiceClient

public PowerAuthServiceClient()

Method Detail

getSystemStatus

public GetSystemStatusResponse getSystemStatus(GetSystemStatusRequest request)

Call the getSystemStatus method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - GetSystemStatusRequest instance

Returns:

GetSystemStatusResponse

getSystemStatus

public GetSystemStatusResponse getSystemStatus()

Call the getSystemStatus method of the PowerAuth 2.0 Server SOAP interface.

Returns:

GetSystemStatusResponse

initActivation

public InitActivationResponse initActivation(InitActivationRequest request)

Call the initActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - InitActivationRequest instance

Returns:

InitActivationResponse

initActivation

public InitActivationResponse initActivation(String userId,
                                             Long applicationId)

Call the initActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

userId - User ID for which a new CREATED activation should be created.

applicationId - Application ID for which a new CREATED activation should be created.

Returns:

InitActivationResponse

initActivation

public InitActivationResponse initActivation(String userId,
                                             Long applicationId,
                                             Long maxFailureCount,
                                             Date timestampActivationExpire)

Call the initActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

userId - User ID for which a new CREATED activation should be created.

applicationId - Application ID for which a new CREATED activation should be created.

maxFailureCount - How many failed attempts should be allowed for this activation.

timestampActivationExpire - Timestamp until when the activation can be committed.

Returns:

InitActivationResponse

prepareActivation

public PrepareActivationResponse prepareActivation(PrepareActivationRequest request)

Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - PrepareActivationRequest instance

Returns:

PrepareActivationResponse

prepareActivation

public PrepareActivationResponse prepareActivation(String activationIdShort,
                                                   String activationName,
                                                   String activationNonce,
                                                   String ephemeralPublicKey,
                                                   String cDevicePublicKey,
                                                   String extras,
                                                   String applicationKey,
                                                   String applicationSignature)

Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationIdShort - Short activation ID.

activationName - Name of this activation.

activationNonce - Activation nonce.

applicationKey - Application key of a given application.

applicationSignature - Signature proving a correct application is sending the data.

cDevicePublicKey - Device public key encrypted with activation OTP.

extras - Additional, application specific information.

Returns:

PrepareActivationResponse

commitActivation

public CommitActivationResponse commitActivation(CommitActivationRequest request)

Call the commitActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - CommitActivationRequest instance

Returns:

CommitActivationResponse

commitActivation

public CommitActivationResponse commitActivation(String activationId)

Call the prepareActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation ID for activation to be commited.

Returns:

CommitActivationResponse

getActivationStatus

public GetActivationStatusResponse getActivationStatus(GetActivationStatusRequest request)

Call the getActivationStatus method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - GetActivationStatusRequest instance

Returns:

GetActivationStatusResponse

getActivationStatus

public GetActivationStatusResponse getActivationStatus(String activationId)

Call the getActivationStatus method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation Id to lookup information for.

Returns:

GetActivationStatusResponse

getActivationListForUser

public GetActivationListForUserResponse getActivationListForUser(GetActivationListForUserRequest request)

Call the getActivationListForUser method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - GetActivationListForUserRequest instance

Returns:

GetActivationListForUserResponse

getActivationListForUser

public List<GetActivationListForUserResponse.Activations> getActivationListForUser(String userId)

Call the getActivationListForUser method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

userId - User ID to fetch the activations for.

Returns:

List of activation instances for given user.

removeActivation

public RemoveActivationResponse removeActivation(RemoveActivationRequest request)

Call the removeActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - RemoveActivationRequest instance.

Returns:

RemoveActivationResponse

removeActivation

public RemoveActivationResponse removeActivation(String activationId)

Call the removeActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation ID of activation to be removed.

Returns:

RemoveActivationResponse

blockActivation

public BlockActivationResponse blockActivation(BlockActivationRequest request)

Call the blockActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - BlockActivationRequest instance.

Returns:

BlockActivationResponse

blockActivation

public BlockActivationResponse blockActivation(String activationId)

Call the blockActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation ID of activation to be blocked.

Returns:

BlockActivationResponse

unblockActivation

public UnblockActivationResponse unblockActivation(UnblockActivationRequest request)

Call the unblockActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - UnblockActivationRequest instance.

Returns:

UnblockActivationResponse

unblockActivation

public UnblockActivationResponse unblockActivation(String activationId)

Call the unblockActivation method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation ID of activation to be unblocked.

Returns:

UnblockActivationResponse

unlockVault

public VaultUnlockResponse unlockVault(VaultUnlockRequest request)

Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - VaultUnlockRequest instance

Returns:

VaultUnlockResponse

unlockVault

public VaultUnlockResponse unlockVault(String activationId,
                                       String applicationKey,
                                       String data,
                                       String signature,
                                       String signatureType)

Call the vaultUnlock method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation Id of an activation to be used for authentication.

applicationKey - Application Key of an application related to the activation.

data - Data to be signed encoded in format as specified by PowerAuth 2.0 data normalization.

signature - Vault opening request signature.

signatureType - Vault opening request signature type.

Returns:

VaultUnlockResponse

verifySignature

public VerifySignatureResponse verifySignature(VerifySignatureRequest request)

Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - VerifySignatureRequest instance.

Returns:

VerifySignatureResponse

verifySignature

public VerifySignatureResponse verifySignature(String activationId,
                                               String applicationKey,
                                               String data,
                                               String signature,
                                               String signatureType)

Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation ID of activation to be used for authentication.

applicationKey - Application Key of an application related to the activation.

data - Data to be signed encoded in format as specified by PowerAuth 2.0 data normalization.

signature - Request signature.

signatureType - Request signature type.

Returns:

Verify signature and return SOAP response with the verification results.

verifyECDSASignature

public VerifyECDSASignatureResponse verifyECDSASignature(VerifyECDSASignatureRequest request)

Call the verifyECDSASignature method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - VerifyECDSASignatureRequest instance.

Returns:

VerifyECDSASignatureResponse

verifyECDSASignature

public VerifyECDSASignatureResponse verifyECDSASignature(String activationId,
                                                         String data,
                                                         String signature)

Call the verifyECDSASignature method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

activationId - Activation ID of activation to be used for authentication.

data - Data that were signed by ECDSA algorithm.

signature - Request signature.

Returns:

Verify ECDSA signature and return SOAP response with the verification results.

generateE2EEncryptionKey

public GetEncryptionKeyResponse generateE2EEncryptionKey(GetEncryptionKeyRequest request)

Call the generateE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - GetEncryptionKeyRequest instance.

Returns:

GetEncryptionKeyResponse

generateE2EEncryptionKey

public GetEncryptionKeyResponse generateE2EEncryptionKey(String activationId)

Call the generateE2EEncryptionKey method of the PowerAuth 2.0 Server SOAP interface and get newly generated derived encryption key.

Parameters:

activationId - Activation ID used for the key generation.

Returns:

GetEncryptionKeyResponse

getSignatureAuditLog

public SignatureAuditResponse getSignatureAuditLog(SignatureAuditRequest request)

Call the getSignatureAuditLog method of the PowerAuth 2.0 Server SOAP interface.

Parameters:

request - SignatureAuditRequest instance.

Returns:

SignatureAuditResponse

getSignatureAuditLog

public List<SignatureAuditResponse.Items> getSignatureAuditLog(String userId,
                                                               Date startingDate,
                                                               Date endingDate)

Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface and get signature audit log for all application of a given user.

Parameters:

userId - User ID to query the audit log against.

startingDate - Limit the results to given starting date (= "newer than")

endingDate - Limit the results to given ending date (= "older than")

Returns:

List of signature audit items SignatureAuditResponse.Items

getSignatureAuditLog

public List<SignatureAuditResponse.Items> getSignatureAuditLog(String userId,
                                                               Long applicationId,
                                                               Date startingDate,
                                                               Date endingDate)

Call the verifySignature method of the PowerAuth 2.0 Server SOAP interface and get signature audit log for a single application.

Parameters:

userId - User ID to query the audit log against.

applicationId - Application ID to query the audit log against.

startingDate - Limit the results to given starting date (= "newer than")

endingDate - Limit the results to given ending date (= "older than")

Returns:

List of signature audit items SignatureAuditResponse.Items

getApplicationList

public GetApplicationListResponse getApplicationList(GetApplicationListRequest request)

Get the list of all applications that are registered in PowerAuth 2.0 Server.

Parameters:

request - GetApplicationListRequest instance.

Returns:

GetApplicationListResponse

getApplicationList

public List<GetApplicationListResponse.Applications> getApplicationList()

Get the list of all applications that are registered in PowerAuth 2.0 Server.

Returns:

List of applications.

getApplicationDetail

public GetApplicationDetailResponse getApplicationDetail(GetApplicationDetailRequest request)

Return the detail of given application, including all application versions.

Parameters:

request - GetApplicationDetailRequest instance.

Returns:

GetApplicationDetailResponse

getApplicationDetail

public GetApplicationDetailResponse getApplicationDetail(Long applicationId)

Get the detail of an application with given ID, including the version list.

Parameters:

applicationId - ID of an application to fetch.

Returns:

Application with given ID, including the version list.

createApplication

public CreateApplicationResponse createApplication(CreateApplicationRequest request)

Create a new application with given name.

Parameters:

request - CreateApplicationRequest instance.

Returns:

CreateApplicationResponse

createApplication

public CreateApplicationResponse createApplication(String name)

Create a new application with given name.

Parameters:

name - Name of the new application.

Returns:

Application with a given name.

createApplicationVersion

public CreateApplicationVersionResponse createApplicationVersion(CreateApplicationVersionRequest request)

Create a version with a given name for an application with given ID.

Parameters:

request - CreateApplicationVersionRequest instance.

Returns:

CreateApplicationVersionResponse

createApplicationVersion

public CreateApplicationVersionResponse createApplicationVersion(Long applicationId,
                                                                 String versionName)

Create a version with a given name for an application with given ID.

Parameters:

applicationId - ID of an application to create a version for.

versionName - Name of the version. The value should follow some well received conventions (such as "1.0.3", for example).

Returns:

A new version with a given name and application key / secret.

unsupportApplicationVersion

public UnsupportApplicationVersionResponse unsupportApplicationVersion(UnsupportApplicationVersionRequest request)

Cancel the support for a given application version.

Parameters:

request - UnsupportApplicationVersionRequest instance.

Returns:

UnsupportApplicationVersionResponse

unsupportApplicationVersion

public UnsupportApplicationVersionResponse unsupportApplicationVersion(Long versionId)

Cancel the support for a given application version.

Parameters:

versionId - Version to be unsupported.

Returns:

Information about success / failure.

supportApplicationVersion

public SupportApplicationVersionResponse supportApplicationVersion(SupportApplicationVersionRequest request)

Renew the support for a given application version.

Parameters:

request - SupportApplicationVersionRequest instance.

Returns:

SupportApplicationVersionResponse

supportApplicationVersion

public SupportApplicationVersionResponse supportApplicationVersion(Long versionId)

Renew the support for a given application version.

Parameters:

versionId - Version to be supported again.

Returns:

Information about success / failure.

createIntegration

public CreateIntegrationResponse createIntegration(CreateIntegrationRequest request)

Create a new integration with given name.

Parameters:

request - Request specifying the integration name.

Returns:

New integration information.

createIntegration

public CreateIntegrationResponse createIntegration(String name)

Create a new integration with given name.

Parameters:

name - Integration name.

Returns:

New integration information.

getIntegrationList

public GetIntegrationListResponse getIntegrationList(GetIntegrationListRequest request)

Get the list of integrations.

Parameters:

request - SOAP request object.

Returns:

List of integrations.

getIntegrationList

public List<GetIntegrationListResponse.Items> getIntegrationList()

Get the list of integrations.

Returns:

List of integrations.

removeIntegration

public RemoveIntegrationResponse removeIntegration(RemoveIntegrationRequest request)

Remove integration with given ID.

Parameters:

request - SOAP object with integration ID to be removed.

Returns:

Removal status.

removeIntegration

public RemoveIntegrationResponse removeIntegration(String id)

Remove integration with given ID.

Parameters:

id - ID of integration to be removed.

Returns:

Removal status.

createCallbackUrl

public CreateCallbackUrlResponse createCallbackUrl(CreateCallbackUrlRequest request)

Create a new callback URL with given request object.

Parameters:

request - SOAP request object with callback URL details.

Returns:

Information about new callback URL object.

createCallbackUrl

public CreateCallbackUrlResponse createCallbackUrl(Long applicationId,
                                                   String name,
                                                   String callbackUrl)

Create a new callback URL with given parameters.

Parameters:

applicationId - Application ID.

name - Callback URL display name.

callbackUrl - Callback URL value.

Returns:

Information about new callback URL object.

getCallbackUrlList

public GetCallbackUrlListResponse getCallbackUrlList(GetCallbackUrlListRequest request)

Get the response with list of callback URL objects.

Parameters:

request - SOAP request object with application ID.

Returns:

Response with the list of all callback URLs for given application.

getCallbackUrlList

public List<GetCallbackUrlListResponse.CallbackUrlList> getCallbackUrlList(Long applicationId)

Get the list of callback URL objects.

Parameters:

applicationId - Application ID.

Returns:

List of all callback URLs for given application.

removeCallbackUrl

public RemoveCallbackUrlResponse removeCallbackUrl(RemoveCallbackUrlRequest request)

Remove callback URL.

Parameters:

request - Remove callback URL request.

Returns:

Information about removal status.

removeCallbackUrl

public RemoveCallbackUrlResponse removeCallbackUrl(String callbackUrlId)

Remove callback URL.

Parameters:

callbackUrlId - Callback URL ID.

Returns:

Information about removal status.