com.manageengine.pam360.sdk.resources

Class AccessControl

java.lang.Object

com.manageengine.pam360.sdk.resources.AccessControl

public final class AccessControl
extends java.lang.Object

Contains methods related to access control operations

Constructor Summary

Constructors

Constructor and Description
AccessControl(PAMService service, APIRequestHandler rest)

Method Summary

Modifier and Type	Method and Description
boolean	approvePasswordRequests(java.lang.String accountName, java.lang.String resourceName, java.lang.String requesterName) Approve the password request for account requested by user
boolean	checkInasAdmin(java.lang.String resourceName, java.lang.String accountName, java.lang.String requesterName) Check in the password requested for account from user by admin
boolean	checkInasUser(java.lang.String resourceName, java.lang.String accountName) Check in the password requested for account by user
java.lang.String	checkOut(java.lang.String accountName, java.lang.String resourceName, java.lang.String reason) Check out the password requested for account
long	getAccountId(java.lang.String resourceName, java.lang.String accountName) to get account id of particular resource
java.util.List<PasswordRequestDetails>	getPasswordRequests() Get the password requests waiting to be approved
java.util.List<PasswordRequestDetails>	getPasswordRequests(java.lang.String reason, long ticketId) Get the password requests waiting to be approved
boolean	rejectPasswordRequest(java.lang.String accountName, java.lang.String resourceName, java.lang.String requesterName) Reject the password request for account requested by user
java.lang.String	requestPasswordApproval(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason) Send request for password approval for an account

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessControl

public AccessControl(PAMService service,
                     APIRequestHandler rest)
              throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

requestPasswordApproval

public java.lang.String requestPasswordApproval(java.lang.String resourceName,
                                                java.lang.String accountName,
                                                java.lang.String reason)
                                         throws SDKConnectionException,
                                                SDKOperationFailedException,
                                                SDKInvalidArgumentException,
                                                SDKRegistrationException

Send request for password approval for an account

Parameters:

resourceName - mandatory, not null name of resource to be requested for approval

accountName - mandatory, not null name of account to be requested for approval

reason - reason for password request

Returns:

String representing the status of the request

Throws:

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

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

SDKRegistrationException

getPasswordRequests

public java.util.List<PasswordRequestDetails> getPasswordRequests()
                                                           throws SDKConnectionException,
                                                                  SDKOperationFailedException

Get the password requests waiting to be approved

Returns:

a list containing instances of PasswordRequestDetails

Throws:

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

getPasswordRequests

public java.util.List<PasswordRequestDetails> getPasswordRequests(java.lang.String reason,
                                                                  long ticketId)
                                                           throws SDKConnectionException,
                                                                  SDKOperationFailedException,
                                                                  SDKInvalidArgumentException

Get the password requests waiting to be approved

Parameters:

reason - mandatory,the reason for getting password request

ticketId - pass the appropriate ticket id if ticketing system is enabled or pass -1

Returns:

a list containing instances of RequestedEntity

Throws:

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

SDKInvalidArgumentException - if reason argument is null or empty

rejectPasswordRequest

public boolean rejectPasswordRequest(java.lang.String accountName,
                                     java.lang.String resourceName,
                                     java.lang.String requesterName)
                              throws SDKConnectionException,
                                     SDKOperationFailedException,
                                     SDKInvalidArgumentException,
                                     SDKRegistrationException

Reject the password request for account requested by user

Parameters:

accountName - mandatory,not null name of account for which access request was sent to

resourceName - mandatory,not null name of reosurce for which access request was sent to

requesterName - mandatory,not null name of user who requested password approval

Returns:

true if password request has been rejected

Throws:

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

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

SDKRegistrationException

approvePasswordRequests

public boolean approvePasswordRequests(java.lang.String accountName,
                                       java.lang.String resourceName,
                                       java.lang.String requesterName)
                                throws SDKConnectionException,
                                       SDKOperationFailedException,
                                       SDKInvalidArgumentException,
                                       SDKRegistrationException

Approve the password request for account requested by user

Parameters:

accountName - mandatory,not null name of account for which the access was request

resourceName - mandatory,not null name of user who requested password approval

requesterName - mandatory,not null name of user who requested password approval

Returns:

true if action is successful

Throws:

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

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

SDKRegistrationException

checkInasAdmin

public boolean checkInasAdmin(java.lang.String resourceName,
                              java.lang.String accountName,
                              java.lang.String requesterName)
                       throws SDKConnectionException,
                              SDKOperationFailedException,
                              SDKInvalidArgumentException,
                              SDKRegistrationException

Check in the password requested for account from user by admin

Parameters:

resourceName - mandatory,not null name of account whose password has to be checked in

accountName - mandatory,not null name of user who requested password

requesterName - mandatory,not null name of user who requested password

Returns:

true if password is checked in successfully

Throws:

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

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

SDKRegistrationException

checkInasUser

public boolean checkInasUser(java.lang.String resourceName,
                             java.lang.String accountName)
                      throws SDKConnectionException,
                             SDKOperationFailedException,
                             SDKInvalidArgumentException,
                             SDKRegistrationException

Check in the password requested for account by user

Parameters:

resourceName - mandatory,not null name of resource whose password has to be checked in

accountName - mandatory,not null name of account whose password has to be checked in

Returns:

true if password is checked in successfully

Throws:

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

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

SDKRegistrationException

checkOut

public java.lang.String checkOut(java.lang.String accountName,
                                 java.lang.String resourceName,
                                 java.lang.String reason)
                          throws SDKConnectionException,
                                 SDKOperationFailedException,
                                 SDKInvalidArgumentException,
                                 SDKRegistrationException

Check out the password requested for account

Parameters:

accountName - mandatory,not null name of account whose password has to be checked out

resourceName - mandatory,not null name of account whose password has to be checked out

reason - reason for checkout, would be mandatory in case where admin demands a reason

Returns:

String representing checkout status

Throws:

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

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

SDKRegistrationException

getAccountId

public long getAccountId(java.lang.String resourceName,
                         java.lang.String accountName)
                  throws SDKRegistrationException,
                         SDKConnectionException,
                         SDKInvalidArgumentException,
                         SDKOperationFailedException

to get account id of particular resource

Parameters:

resourceName - mandatory,not null,name of the resource the account belogs to.

accountName - mandatory,not null,name of the account

Returns:

long account id of the account

Throws:

SDKRegistrationException

SDKConnectionException

SDKInvalidArgumentException

SDKOperationFailedException