com.manageengine.pam360.sdk.resources

Class ResourceGroup

java.lang.Object

com.manageengine.pam360.sdk.resources.ResourceGroup

public final class ResourceGroup
extends java.lang.Object

Contains methods related to resource group operations

Constructor Summary

Constructors

Constructor and Description
ResourceGroup(PAMService service, APIRequestHandler rest)

Method Summary

Modifier and Type	Method and Description
boolean	associateResources(java.util.ArrayList<java.lang.String> resourceNames, java.lang.String groupName, java.lang.String userName) associate the resources to static group
boolean	associateResources(java.util.ArrayList resourceIds, java.lang.Long groupId) associate the resources to static group
boolean	createResourceGroup(ResourceGroupModel resourceGroupModel) Create a dynamic resource group based on criteria and static group
boolean	deleteResourceGroup(long groupId) Delete the Resourcegroup using resource id
boolean	deleteResourceGroup(java.lang.String groupName, java.lang.String userName) Delete the Resourcegroup using group name
boolean	disassociateResources(java.util.ArrayList<java.lang.String> resourceNames, java.lang.String groupName, java.lang.String userName) disassociate the resources to static group
boolean	disassociateResources(java.util.ArrayList resourceIds, java.lang.Long groupId) disassociate the resources to static group
org.json.JSONArray	fetchAllResourceGroups(long limit, long startIndex, sdkEnumConstants.SearchType searchType, sdkEnumConstants.SearchColumn searchColumn, java.lang.String searchValue) to fetch all resource groups matching the given value under given column name
long	getResourceGroupID(java.lang.String groupName, java.lang.String userName) Get the ID of the particular group

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceGroup

public ResourceGroup(PAMService service,
                     APIRequestHandler rest)
              throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

createResourceGroup

public boolean createResourceGroup(ResourceGroupModel resourceGroupModel)
                            throws SDKConnectionException,
                                   SDKOperationFailedException,
                                   SDKInvalidArgumentException

Create a dynamic resource group based on criteria and static group

Parameters:

resourceGroupModel - mandatory,not null instance of ResourceGroupModel with necessary fields set

Returns:

true if dynamic group has been created

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

associateResources

public boolean associateResources(java.util.ArrayList<java.lang.String> resourceNames,
                                  java.lang.String groupName,
                                  java.lang.String userName)
                           throws SDKInvalidArgumentException,
                                  SDKConnectionException,
                                  SDKOperationFailedException

associate the resources to static group

Parameters:

resourceNames - mandatory not null,arrayList of names of the resource to be associated

groupName - mandatory not null,the name to which resource have to be associated

userName - mandatory not null,the name of the user owning the resource

Returns:

true if Resource has been associated 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

associateResources

public boolean associateResources(java.util.ArrayList resourceIds,
                                  java.lang.Long groupId)
                           throws SDKInvalidArgumentException,
                                  SDKOperationFailedException,
                                  SDKConnectionException

associate the resources to static group

Parameters:

resourceIds - mandatory,list of ids to be associated mandatory, non negative ID of the resource

groupId - mandatory, non negative ID of the group

Returns:

true if Resource has been associated 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

disassociateResources

public boolean disassociateResources(java.util.ArrayList<java.lang.String> resourceNames,
                                     java.lang.String groupName,
                                     java.lang.String userName)
                              throws SDKInvalidArgumentException,
                                     SDKConnectionException,
                                     SDKOperationFailedException

disassociate the resources to static group

Parameters:

resourceNames - mandatory not null,arrayList of names of the resource to be disassociated

groupName - mandatory, not null,the name to which resource have to be disassociated

userName - mandatory,not null,the name of the user owning the resource

Returns:

true if Resource has been disassociated 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

disassociateResources

public boolean disassociateResources(java.util.ArrayList resourceIds,
                                     java.lang.Long groupId)
                              throws SDKInvalidArgumentException,
                                     SDKOperationFailedException,
                                     SDKConnectionException

disassociate the resources to static group

Parameters:

groupId - mandatory, non negative ID of the group

resourceIds - mandatory,list of ids to be associated mandatory, non negative ID of the resource

Returns:

true if Resource has been disassociated 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

deleteResourceGroup

public boolean deleteResourceGroup(long groupId)
                            throws SDKConnectionException,
                                   SDKOperationFailedException,
                                   SDKInvalidArgumentException

Delete the Resourcegroup using resource id

Parameters:

groupId - mandatory, non negative ID of the resource

Returns:

true if Resourcegroup 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

deleteResourceGroup

public boolean deleteResourceGroup(java.lang.String groupName,
                                   java.lang.String userName)
                            throws SDKConnectionException,
                                   SDKOperationFailedException,
                                   SDKInvalidArgumentException

Delete the Resourcegroup using group name

Parameters:

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

userName - mandatory,non null,non empty ame of the user

Returns:

true if Resourcegroup 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

getResourceGroupID

public long getResourceGroupID(java.lang.String groupName,
                               java.lang.String userName)
                        throws SDKConnectionException,
                               SDKOperationFailedException,
                               SDKInvalidArgumentException

Get the ID of the particular group

Parameters:

groupName - mandatory not null, non empty name of the resourcegroup

userName - mandatory not null, non empty name of the user

Returns:

group id as long

Throws:

SDKConnectionException - if unable to connect to the server

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

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

fetchAllResourceGroups

public org.json.JSONArray fetchAllResourceGroups(long limit,
                                                 long startIndex,
                                                 sdkEnumConstants.SearchType searchType,
                                                 sdkEnumConstants.SearchColumn searchColumn,
                                                 java.lang.String searchValue)
                                          throws SDKInvalidArgumentException,
                                                 SDKConnectionException,
                                                 SDKOperationFailedException

to fetch all resource groups matching the given value under given column name

Parameters:

limit - mandatory,number of rows to be fetched

startIndex - mandatory,index number from which the response row will be displayed

searchType - mandatory,group type wether static or dynamic or all to be fetched

searchColumn - mandatory,column name to be searched

searchValue - mandatory,value to be searched under the column

Returns:

jsonArray of groupdetails

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