com.manageengine.pam360.sdk.resources

Class Resource

java.lang.Object

com.manageengine.pam360.sdk.resources.Resource

public final class Resource
extends java.lang.Object

Contains methods related to Resource

Constructor Summary

Constructors

Constructor and Description
Resource(PAMService service, APIRequestHandler rest)

Method Summary

Modifier and Type	Method and Description
CreateResourceDetails	createResource(ResourceModel resourceModel) Create a new resource with provided attributes
boolean	deleteResource(long resourceId) Delete the Resource using resource id
boolean	deleteResource(java.lang.String resourceName) Delete the Resource using resource name
org.json.JSONObject	downloadFile(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason) To get contents of files, keys, certificates, etc.
org.json.JSONObject	downloadFile(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason, boolean isCustomField, sdkEnumConstants.CustomFieldType customFieldType, java.lang.String customFieldLabel) To get contents of files, keys, certificates, etc.
org.json.JSONObject	downloadFile(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason, long ticketId) To get contents of files, keys, certificates, etc.
org.json.JSONObject	downloadFile(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason, long ticketId, boolean isCustomField, sdkEnumConstants.CustomFieldType customFieldType, java.lang.String customFieldLabel) To get contents of files, keys, certificates, etc.
boolean	editResource(java.lang.String resourceName, ResourceModel resourceModel) Edit already existing resource
java.util.List<AccountOfResource>	getAccounts(long resourceId) Get the accounts that are part of a resource using resource id
java.util.List<AccountOfResource>	getAccounts(java.lang.String resourceName) Get the accounts that belongs to the resource using resource name
org.json.JSONObject	getAllResourceTypes(org.json.JSONArray resTypeNames) To list all the resource types in the organization.
org.json.JSONObject	getassociatedResourceGroups(java.lang.String resourceName) get resource group names of the particular resource associated
ResourceAccountID	getResourceAndAccountID(java.lang.String resourceName, java.lang.String accountName) Get the unique ID of the resource and account
long	getResourceID(java.lang.String resourceName) Get the unique ID of the resource
java.util.List<ResourceDetails>	getSharedResources() To get the list of resources which are owned by or shared to the user.
boolean	shareResourceToUsergroup(java.lang.String resourceName, sdkEnumConstants.AccessPermission accessPermission, java.lang.String usergroupName) share a resource to usergroup
boolean	sharerResourceToUser(java.lang.String resourceName, java.lang.String userName, sdkEnumConstants.AccessPermission accessPermission) Share a resource to an user using resource and user name

Methods inherited from class java.lang.Object

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

Constructor Detail

Resource

public Resource(PAMService service,
                APIRequestHandler rest)
         throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

getSharedResources

public java.util.List<ResourceDetails> getSharedResources()
                                                   throws SDKConnectionException,
                                                          SDKOperationFailedException

To get the list of resources which are owned by or shared to the user.

Returns:

List of ResourceDetails objects containing resource details

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

getAccounts

public java.util.List<AccountOfResource> getAccounts(long resourceId)
                                              throws SDKConnectionException,
                                                     SDKOperationFailedException,
                                                     SDKInvalidArgumentException

Get the accounts that are part of a resource using resource id

Parameters:

resourceId - mandatory,a non negative ID of the resource whose accounts are to be fetched

Returns:

list of AccountOfResource instances containing details of accounts under the resource

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

getAccounts

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

Get the accounts that belongs to the resource using resource name

Parameters:

resourceName - mandatory,a non null and non empty name of the resource whose accounts are to be fetched

Returns:

list of AccountOfResource instances containing details of accounts under the resource

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

createResource

public CreateResourceDetails createResource(ResourceModel resourceModel)
                                     throws SDKConnectionException,
                                            SDKOperationFailedException,
                                            SDKInvalidArgumentException

Create a new resource with provided attributes

Parameters:

resourceModel - mandatory,instance of ResourceModel with all necessary field set

Returns:

true if resource is created 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

editResource

public boolean editResource(java.lang.String resourceName,
                            ResourceModel resourceModel)
                     throws SDKConnectionException,
                            SDKOperationFailedException,
                            SDKInvalidArgumentException

Edit already existing resource

Parameters:

resourceName - mandatory, non negative ID of the resource to edit

resourceModel - mandatory,instance of ResourceModel with necessary field set.

The field resourceName is mandatory and has to be set before passing resource model to this function

Returns:

true if resource edit 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

getResourceAndAccountID

public ResourceAccountID getResourceAndAccountID(java.lang.String resourceName,
                                                 java.lang.String accountName)
                                          throws SDKConnectionException,
                                                 SDKOperationFailedException,
                                                 SDKInvalidArgumentException

Get the unique ID of the resource and account

Parameters:

resourceName - mandatory, non null, non empty name of the resource

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

Returns:

a instance of ResourceAccountID containing resource and account id

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

getResourceID

public long getResourceID(java.lang.String resourceName)
                   throws SDKConnectionException,
                          SDKOperationFailedException,
                          SDKInvalidArgumentException

Get the unique ID of the resource

Parameters:

resourceName - mandatory, non null, non empty name of the resource

Returns:

resource id as long

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

deleteResource

public boolean deleteResource(long resourceId)
                       throws SDKConnectionException,
                              SDKOperationFailedException,
                              SDKInvalidArgumentException

Delete the Resource using resource id

Parameters:

resourceId - mandatory, non negative ID of the resource

Returns:

true if resource has been deleted 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

deleteResource

public boolean deleteResource(java.lang.String resourceName)
                       throws SDKConnectionException,
                              SDKOperationFailedException,
                              SDKInvalidArgumentException

Delete the Resource using resource name

Parameters:

resourceName - mandatory, non null, non empty name of the resource

Returns:

true if resource has been deleted

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

sharerResourceToUser

public boolean sharerResourceToUser(java.lang.String resourceName,
                                    java.lang.String userName,
                                    sdkEnumConstants.AccessPermission accessPermission)
                             throws SDKConnectionException,
                                    SDKOperationFailedException,
                                    SDKInvalidArgumentException

Share a resource to an user using resource and user name

Parameters:

resourceName - mandatory, non null, non empty name of resource to be shared

userName - mandatory, non null, non empty name of user to whom resource is to be shared

accessPermission - mandatory non null sdkEnumConstants.AccessPermission, accessLevel to be provided to the user over the resource

Returns:

true if resource has been shared to user

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

getassociatedResourceGroups

public org.json.JSONObject getassociatedResourceGroups(java.lang.String resourceName)
                                                throws SDKInvalidArgumentException,
                                                       SDKConnectionException,
                                                       SDKOperationFailedException

get resource group names of the particular resource associated

Parameters:

resourceName - mandatory,not null name of the resource.

Returns:

JSONOBJECT which contains details of groupname and groupid.

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

shareResourceToUsergroup

public boolean shareResourceToUsergroup(java.lang.String resourceName,
                                        sdkEnumConstants.AccessPermission accessPermission,
                                        java.lang.String usergroupName)
                                 throws SDKConnectionException,
                                        SDKOperationFailedException,
                                        SDKInvalidArgumentException

share a resource to usergroup

Parameters:

resourceName - mandatory,not null name of the resource to be shared

accessPermission - mandatory,type of accesspermission

usergroupName - mandatory,not null name of the usergroup to which the resource have to be shared

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

getAllResourceTypes

public org.json.JSONObject getAllResourceTypes(org.json.JSONArray resTypeNames)
                                        throws SDKInvalidArgumentException,
                                               SDKConnectionException,
                                               SDKOperationFailedException

To list all the resource types in the organization.

Parameters:

resTypeNames - mandatory,not null list of resource type names

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

downloadFile

public org.json.JSONObject downloadFile(java.lang.String resourceName,
                                        java.lang.String accountName,
                                        java.lang.String reason)
                                 throws SDKInvalidArgumentException,
                                        SDKConnectionException,
                                        SDKOperationFailedException

To get contents of files, keys, certificates, etc. that are either an individual resource or a part of other resources.This method can be used when the particular resource have not enabled ticketing system and has no custom field label.

Parameters:

resourceName - mandatory,not null name of the resource

accountName - mandatory,not null name of the account

reason - optional,reason,if any specific reason is available

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

downloadFile

public org.json.JSONObject downloadFile(java.lang.String resourceName,
                                        java.lang.String accountName,
                                        java.lang.String reason,
                                        long ticketId)
                                 throws SDKInvalidArgumentException,
                                        SDKConnectionException,
                                        SDKOperationFailedException

To get contents of files, keys, certificates, etc. that are either an individual resource or a part of other resources.This method can be used when the particular resource have enabled ticketing system and has no custom field label.

Parameters:

resourceName - mandatory,not null name of the resource

accountName - mandatory,not null name of the account

reason - optional,reason,if any specific reason is available

ticketId - mandatory,not negative ticketid,if ticketing system is enabled

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

downloadFile

public org.json.JSONObject downloadFile(java.lang.String resourceName,
                                        java.lang.String accountName,
                                        java.lang.String reason,
                                        boolean isCustomField,
                                        sdkEnumConstants.CustomFieldType customFieldType,
                                        java.lang.String customFieldLabel)
                                 throws SDKInvalidArgumentException,
                                        SDKConnectionException,
                                        SDKOperationFailedException

To get contents of files, keys, certificates, etc. that are either an individual resource or a part of other resources.This method can be used when the particular resource has custom field label and not enabled ticketing system.

Parameters:

resourceName - mandatory,not null name of the resource

accountName - mandatory,not null name of the account

reason - optional,reason,if any specific reason is available

isCustomField - mandatory,boolean value wether customfield is present for the particular resource

customFieldType - mandatory,not null type of the customfield - resource/Account

customFieldLabel - mandatory,not null name of the customfield label

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

downloadFile

public org.json.JSONObject downloadFile(java.lang.String resourceName,
                                        java.lang.String accountName,
                                        java.lang.String reason,
                                        long ticketId,
                                        boolean isCustomField,
                                        sdkEnumConstants.CustomFieldType customFieldType,
                                        java.lang.String customFieldLabel)
                                 throws SDKInvalidArgumentException,
                                        SDKConnectionException,
                                        SDKOperationFailedException

To get contents of files, keys, certificates, etc. that are either an individual resource or a part of other resources.This method can be used when the particular resource have enabled ticketing system and has custom field label.

Parameters:

resourceName - mandatory,not null name of the resource

accountName - mandatory,not null name of the account

reason - optional,reason,if any specific reason is available

ticketId - mandatory,not negative ticketid,if ticketing system is enabled

isCustomField - mandatory,boolean value wether customfield is present for the particular resource

customFieldType - mandatory,not null type of the customfield - resource/Account

customFieldLabel - mandatory,not null name of the customfield label

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