com.manageengine.pam360.sdk.pki

Class SSHKey

java.lang.Object

com.manageengine.pam360.sdk.pki.SSHKey

public final class SSHKey
extends java.lang.Object

Contains methods related to SSHKey operations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSHKey.KeyType Specify and set appropriate key type in setKeyType function of SSHKeyModel class

Constructor Summary

Constructors

Constructor and Description
SSHKey(PAMService service, APIRequestHandler rest, java.util.Map<java.lang.String,java.lang.String> connectionParams)

Method Summary

Modifier and Type	Method and Description
boolean	associate(java.lang.String keyName, java.lang.String resourceName, java.lang.String accountName) Associate a key to an account under a resource
boolean	create(SSHKeyModel sshKeyModel) Create a new SSH key
boolean	delete(java.lang.String keyName, boolean withoutDisassociation) Delete an SSH Key
boolean	disassociate(java.lang.String keyName, java.lang.String resourceName, java.lang.String accountName) Disassociate the key associated to an account under a resource
java.lang.String	exportKey(java.lang.String keyName) Get the contents of a key
java.util.List<AssociatedUser>	fetchAssociatedUsers() Fetch the list of users (accounts under resource) and their associated key
java.util.List<SSHKeyDetails>	getAllKeys() Get all ssh keys added by the user
java.util.List<java.lang.String>	getKeyForUser(java.lang.String resourceName, java.lang.String userName) Get the keys associated to users (accounts) under a resource
SSHKeyDetails	getParticularKey(java.lang.String keyName) Fetch a particular key by its name
boolean	importKey(java.lang.String keyName, java.lang.String passPhrase, java.lang.String filePath) Import a key file

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHKey

public SSHKey(PAMService service,
              APIRequestHandler rest,
              java.util.Map<java.lang.String,java.lang.String> connectionParams)
       throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

create

public boolean create(SSHKeyModel sshKeyModel)
               throws SDKInvalidArgumentException,
                      SDKConnectionException,
                      SDKOperationFailedException

Create a new SSH key

Parameters:

sshKeyModel - an instance of SSHKeyModel with all fields set

Returns:

true if ssk key is created successfully

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

delete

public boolean delete(java.lang.String keyName,
                      boolean withoutDisassociation)
               throws SDKInvalidArgumentException,
                      SDKConnectionException,
                      SDKOperationFailedException

Delete an SSH Key

Parameters:

keyName - not null, non empty unique name for the SSH key

withoutDisassociation - set as true, if key is to be deleted without disassociation

Returns:

true if key is deleted successfully

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

getAllKeys

public java.util.List<SSHKeyDetails> getAllKeys()
                                         throws SDKConnectionException,
                                                SDKOperationFailedException

Get all ssh keys added by the user

Returns:

List of SSHKeyDetails containing details of all SSH keys

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

getParticularKey

public SSHKeyDetails getParticularKey(java.lang.String keyName)
                               throws SDKInvalidArgumentException,
                                      SDKConnectionException,
                                      SDKOperationFailedException

Fetch a particular key by its name

Parameters:

keyName - not null, non empty name of the key to be fetched

Returns:

an instance of SSHKeyDetails containing details of the key

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

exportKey

public java.lang.String exportKey(java.lang.String keyName)
                           throws SDKInvalidArgumentException,
                                  SDKConnectionException,
                                  SDKOperationFailedException

Get the contents of a key

Parameters:

keyName - not null, not empty name of key whose content is to be fetched

Returns:

content of key as String

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

getKeyForUser

public java.util.List<java.lang.String> getKeyForUser(java.lang.String resourceName,
                                                      java.lang.String userName)
                                               throws SDKInvalidArgumentException,
                                                      SDKConnectionException,
                                                      SDKOperationFailedException

Get the keys associated to users (accounts) under a resource

Parameters:

resourceName - not null, non empty name of resource under which account is present

userName - not null, non empty username (account name) under a resource

Returns:

list of string containing name of keys associated to the user (account)

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

associate

public boolean associate(java.lang.String keyName,
                         java.lang.String resourceName,
                         java.lang.String accountName)
                  throws SDKInvalidArgumentException,
                         SDKConnectionException,
                         SDKOperationFailedException

Associate a key to an account under a resource

Parameters:

keyName - not null, non empty name of the key to be associated

resourceName - not null, non empty name of resource under which account is present

accountName - not null, non empty name of the account under a resource

Returns:

true if key has been associated successfully

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

disassociate

public boolean disassociate(java.lang.String keyName,
                            java.lang.String resourceName,
                            java.lang.String accountName)
                     throws SDKInvalidArgumentException,
                            SDKConnectionException,
                            SDKOperationFailedException

Disassociate the key associated to an account under a resource

Parameters:

keyName - not null, non empty name of the key to be disassociated

resourceName - not null, non empty name of resource

accountName - not null, non empty name of the account under a resource

Returns:

true if key is successfully disassociated

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

fetchAssociatedUsers

public java.util.List<AssociatedUser> fetchAssociatedUsers()
                                                    throws SDKConnectionException,
                                                           SDKOperationFailedException

Fetch the list of users (accounts under resource) and their associated key

Returns:

List of AssociatedUser instance

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

importKey

public boolean importKey(java.lang.String keyName,
                         java.lang.String passPhrase,
                         java.lang.String filePath)
                  throws SDKInvalidArgumentException,
                         SDKConnectionException,
                         SDKOperationFailedException

Import a key file

Parameters:

keyName - not null, non empty name of the key should be imported as

passPhrase - passphrase of the key to be imported

filePath - system path of the key file (also specify the file extension. eg: C:/user/admin/Testkey.ppk)

Returns:

true if key has been imported successfully

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request