31.2 Resource Web Service Interface

This section provides details about the methods available with the Resource Web service. This programming interface presumes you’re using Java code generated by the WSSDK toolkit. The interface will be different if you’re using another Web Service toolkit.

31.2.1 IRemoteResource

This section provides reference information for each method associated with the IRemoteResource interface.

checkCodeMapValueStatus

Checks to see if a particular value exists in the code map table for a specified entitlement and logical system. The method returns the status for the code map value as a CodeMapValueStatus object.

This method is one of three SOAP endpoints to help you keep the code map tables for the Roles Based Provisioning Module synchronized with the code map tables for the Role Mapping Administrator. The user interface for the Role Mapping Administrator can trigger a code map refresh if a mismatch is discovered while a user is creating mappings. In addition, the Roles Based Provisioning Module allows you to use the three SOAP endpoints to refresh selected entitlements within its code map tables.

In addition to checkCodeMapValueStatus, the Roles Based Provisioning Module includes the following endpoints to help with code map synchronization:

  • getRefreshStatus

  • refreshCodeMap

The Entitlement Query Settings section of the Configure Roles and Resources Settings page in the identity applications allows you to specify how often the Roles Based Provisioning Module code map tables are refreshed and also start a manual refresh. However, this page does not allow to refresh selected entitlements. To control which entitlements are refreshed, you need to use the SOAP endpoints.

For additional information on the getRefreshStatus endpoint, see getRefreshStatus. For additional information on the refreshCodeMap endpoint, see refreshCodeMap.

For code samples that use the new methods for code map synchronization, see Code Map Synchronization Code Samples.

Syntax: Here is the method signature:

public CodeMapValueStatus checkCodeMapValueStatus(String entitilementDN, String connectionName, String codeMapValue)
       throws NrfServiceException, RemoteException;

The parameters are described below:

  • entitlementDN entitlement DN as a string.

    For example:

    cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system
  • connectionName connection (logical system) name. This is an optional parameter. Only fanout drivers need to specify the connection name.

  • codeMapValue code map value to verify.

    For example:

    \TEST1\data\groups\netiq\cambridge\rbpm\4AlphaGroup

SOAP Request: Here is the SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.netiq.com/resource/service">
<soapenv:Header/>
<soapenv:Body>
<ser:checkCodeMapValueStatusRequest>
<!--Optional:-->
<ser:entitilementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</ser:entitilementDN>
<!--Optional:-->
<ser:connectionName/>
<!--Optional:-->
<ser:codeMapValue>\WILLIAMS1\data\groups\netiq\cambridge\rbpm\4AlphaGroup</ser:codeMapValue>
</ser:checkCodeMapValueStatusRequest>
</soapenv:Body>
</soapenv:Envelope>

SOAP Response: Here is the SOAP response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:checkCodeMapValueStatusResponse xmlns="http://www.netiq.com/resource/service" xmlns:ns1="http://www.netiq.com/resource/service">
<result>
<refreshStatus>
<connectionName xsi:nil="1"/>
<entitlementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</entitlementDN>
<guid>\2d\13\d1\a4\7b\99\d6\4c\03\9a\2d\13\d1\a4\7b\99</guid>
<lastRefresh>1329431650891</lastRefresh>
<status>SUCCESS</status>
</refreshStatus>
<upToDate>true</upToDate>
<value>\WILLIAMS1\data\groups\netiq\cambridge\rbpm\4AlphaGroup</value>
</result>
</ns1:checkCodeMapValueStatusResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

createResource

Creates a new resource according to the specified parameters, and returns a DN of the created resource.

A correlation ID is generated automatically for this method that uses this format:

UserApp#RemoteResourceRequest#xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

The correlation ID is used for auditing.

Syntax: Here is the method signature:

public String createResource(Resource resource)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resource specifies the resource object to create.

createResourceAid

Creates a new resource, with a correlation ID that you provide. The correlation ID is used for auditing to link a set of related resources. This method creates the resource according to the specified parameters, and returns a DN of the created resource.

Syntax: Here is the method signature:

public String createResourceAid(Resource resource, String correlationId)
            throws NrfServiceException, RemoteException;

findResourceByExampleWithOperator

Finds all Resource objects based on the search criteria specified in the given Resource object.

Syntax: Here is the method signature:

public Resource[] findResourceByExampleWithOperator(Resource searchCriteria, boolean useAndForMultiValueSearch)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • searchCriteria specifies Query by Example (QBE) search criteria within a Resource object.

  • useAndForMultiValueSearch determines whether AND or OR will be used for multi-value search expressions. If you specify a value of true, AND will be used for multi-value searches; if you specify a value of false, OR will be used.

getEntitlementCodeMap

Returns an array of ProvisioningCodeMap objects, which include code map information from the code map and code map label tables.

Syntax: Here is the method signature:

ProvisioningCodeMap[] getEntitlementCodeMap(java.lang.String codeMapKey, int type)
        throws com.novell.idm.nrf.soap.ws.resource.NrfServiceException, java.rmi.RemoteException;

The parameters are described below:

  • codeMapKey specifies the code map key to retrieve values from. The codeMapKey is a GUID that acts as a unique identifier for the code map. For example:

    \2d\13\d1\a4\7b\99\d6\4c\03\9a\2d\13\d1\a4\7b\99
  • type specifies the code map type. A value of 0 filters the list to include entitlement code maps only.

getRefreshStatus

Gets the refresh status of a code map based on a specified entitlement DN. This method returns the status as an array of CodeMapRefreshStatus objects. The structure returned contains the DN, GUID, connection name status, and last refresh time.

This method is one of three SOAP endpoints to help you keep the code map tables for the Roles Based Provisioning Module synchronized with the code map tables for the Role Mapping Administrator. The user interface for the Role Mapping Administrator can trigger a code map refresh if a mismatch is discovered while a user is creating mappings. In addition, the Roles Based Provisioning Module allows you to use the three SOAP endpoints to refresh selected entitlements within its code map tables.

In addition to getRefreshStatus, the Roles Based Provisioning Module includes the following endpoints to help with code map synchronization:

  • checkCodeMapValueStatus

  • refreshCodeMap

The Entitlement Query Settings section of the Configure Roles and Resources Settings page in the identity applications allows you to specify how often the Roles Based Provisioning Module code map tables are refreshed and also start a manual refresh. However, this page does not allow to refresh selected entitlements. To control which entitlements are refreshed, you need to use the SOAP endpoints.

For additional information on the checkCodeMapValueStatus endpoint, see checkCodeMapValueStatus. For additional information on the refreshCodeMap endpoint, see refreshCodeMap.

For code samples that use the new methods for code map synchronization, see Code Map Synchronization Code Samples.

Syntax: Here is the method signature:

 public CodeMapRefreshStatus[] getRefreshStatus(String entitlementDN)
           throws NrfServiceException, RemoteException;

The parameters are described below:

  • entitlementDN entitlement DN as a string

    For example:

    cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system

SOAP Request: Here is the SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.netiq.com/resource/service">
<soapenv:Header/>
<soapenv:Body>
<ser:getRefreshStatusRequest>
<!--Optional:-->
<ser:entitlementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</ser:entitlementDN>
</ser:getRefreshStatusRequest>
</soapenv:Body>
</soapenv:Envelope>

SOAP Response: Here is the SOAP response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:getRefreshStatusResponse xmlns="http://www.netiq.com/resource/service" xmlns:ns1="http://www.netiq.com/resource/service">
<result>
<codemaprefreshstatus>
<connectionName xsi:nil="1"/>
<entitlementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</entitlementDN>
<guid>\2d\13\d1\a4\7b\99\d6\4c\03\9a\2d\13\d1\a4\7b\99</guid>
<lastRefresh>1329100366090</lastRefresh>
<status>SUCCESS</status>
</codemaprefreshstatus>
</result>
</ns1:getRefreshStatusResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getResourceAssignmentsForCurrentUser

Returns the resource assignments for the current user.

Syntax: Here is the method signature:

ResourceAssignment[] getResourceAssignmentsForCurrentUser()
        throws com.novell.idm.nrf.soap.ws.resource.NrfServiceException, java.rmi.RemoteException;

getResourceAssignmentsForUser

Returns the resource assignments for a particular user.

Syntax: Here is the method signature:

ResourceAssignment[] getResourceAssignmentsForUser(java.lang.String userDn)
        throws com.novell.idm.nrf.soap.ws.resource.NrfServiceException, java.rmi.RemoteException;

The parameters are described below:

  • userDn DN of the target user

getAssignmentsForResource

Returns the resource assignments for a particular resource.

Syntax: Here is the method signature:

ResourceAssignment[] getAssignmentsForResource(java.lang.String resourceDn)
        throws com.novell.idm.nrf.soap.ws.resource.NrfServiceException, java.rmi.RemoteException;

The parameters are described below:

  • resourceDn DN of the target resource

getResourceRequestStatusByCorrelationId

Returns all resource request status items for a given correlation ID.

Syntax: Here is the method signature:

public ResourceAssignmentRequestStatus[]
           getResourceRequestStatusByCorrelationId 
                   (String correlationId, String locale)
               throws NrfServiceException, RemoteException;

The parameters are described below:

  • correlationId specifies a resource assignment request correlation ID.

  • locale supplies an iso639 language code to format localized string values; if the parameter is null, the language defaults to the servlet request locale.

This method returns all resource request status instances for the specified correlationId parameter value. For more information on the ResourceAssignmentRequestStatus class, see ResourceAssignmentRequestStatus.

getResourceRequestsStatusForCurrentUser

Returns all resource request status items for the authenticated user.

Syntax: Here is the method signature:

 public ResourceAssignmentRequestStatus[]     
                  getResourceRequestStatusForCurrentUser(String locale)
               throws NrfServiceException, RemoteException;

The parameters are described below:

  • locale supplies an iso639 language code to format localized string values; if the parameter is null, the language defaults to the servlet request locale.

This method returns all resource request status instances for the specified correlationId parameter value. For more information on the ResourceAssignmentRequestStatus class, see ResourceAssignmentRequestStatus.

getResourceRequestStatusByIdentity

Returns all resource assignment request status items for a particular user identity.

Syntax: Here is the method signature:

public ResourceAssignmentRequestStatus[]
           getResourceRequestStatusByIdentity(String identity, String locale)
        throws NrfServiceException, RemoteException;

The parameters are described below:

  • identity specifies the DN for a user.

  • locale supplies an iso639 language code to format localized string values; if the parameter is null, the language defaults to the servlet request locale.

This method returns all resource request status instances for the specified correlationId parameter value. For more information on the ResourceAssignmentRequestStatus class, see ResourceAssignmentRequestStatus.

getCodeMapValues

Returns a list of code map values for a specified code map.

Syntax: Here is the method signature:

public CodeMapValue[] getCodeMapValues(String codeMapKey, String locale)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • codeMapKey specifies the code map key to retrieve values from. The codeMapKey is a GUID that acts as a unique identifier for the code map. For example:

    \2d\13\d1\a4\7b\99\d6\4c\03\9a\2d\13\d1\a4\7b\99
  • locale supplies an iso639 language code to format localized string values; if the parameter is null, the language defaults to the servlet request locale.

getResource

Returns a resource object.

Syntax: Here is the method signature:

 public Resource getResource(String dn, String locale)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • dn specifies the DN of the resource you want to retrieve.

  • locale supplies an iso639 language code to format localized string values; if the parameter is null, the language defaults to the servlet request locale.

getResourceLocalizedStrings

Gets the localized strings for a resource, such as the names and descriptions. The type parameter lets you specify whether the names or descriptions should be retrieved.

Syntax: Here is the method syntax:

public LocalizedValue[] getResourceLocalizedStrings(String resourceDn, int type)throws NrfServiceException, RemoteException;

The parameters are described below:

  • resourceDn specifies the DN of the resource for which you want to get the localized strings.

  • type specifies the type of localized strings you want to retrieve. A type value of 1 retrieves a list of names for the resource, whereas a type value of 2 retrieves a list of descriptions.

getResourcessInfoByCategory

Returns a list of ResourceInfo instances given a list of category keys.

Syntax: Here is the method signature:

public ResourceInfo[] getResourcessInfoByCategory(CategoryKey[] resourceCategoryKeys)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resourceCategoryKeys specifies the list of resource category keys to retrieve resource information objects for.

getResourcessInfo

Returns a list of ResourceInfo instances given a list of resource DNs.

Syntax: Here is the method signature:

public ResourceInfo[] getResourcessInfo(DNString[] resDns)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resDns provides a list of resource DNs for which you want to retrieve resource information objects.

modifyResource

Modifies a resource definition. This method does not perform a localized string modification update. To update the localized names or descriptions for a resource, you need to use the setResourceLocalizedStrings method.

A correlation ID is generated automatically for this method that uses this format:

UserApp#RemoteResourceRequest#xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Syntax: Here is the method signature:

public Resource modifyResource(Resource resource)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resource specifies the resource object to modify.

modifyResourceAid

Modifies a resource definition, with a correlation ID that you provide. The correlation ID is used for auditing to link a set of related resources. This method does not perform a localized string modification update. To update the localized names or descriptions for a resource, you need to use the setResourceLocalizedStrings method.

Syntax: Here is the method signature:

public Resource modifyResourceAid(Resource resource, String correlationId)
            throws NrfServiceException, RemoteException;

refreshCodeMap

Refreshes the code map based on a specified entitlement DN. The method returns the status of the refresh operation in the form of an EntitlementRefreshInfo object. This structure includes the detailed status as an array of CodeMapRefreshStatus objects.

This method is one of three SOAP endpoints to help you keep the code map tables for the Roles Based Provisioning Module synchronized with the code map tables for the Role Mapping Administrator. The user interface for the Role Mapping Administrator can trigger a code map refresh if a mismatch is discovered while a user is creating mappings. In addition, the Roles Based Provisioning Module allows you to use the three SOAP endpoints to refresh selected entitlements within its code map tables.

In addition to refreshCodeMap, the Roles Based Provisioning Module includes the following endpoints to help with code map synchronization:

  • checkCodeMapValueStatus

  • getRefreshStatus

The Entitlement Query Settings section of the Configuration > Roles and Resources page in the Identity Manager Dashboard allows you to specify how often the Roles Based Provisioning Module code map tables are refreshed and also start a manual refresh.

For additional information on the checkCodeMapValueStatus endpoint, see checkCodeMapValueStatus. For additional information on the getRefreshStatus endpoint, see getRefreshStatus.

For code samples that use the new methods for code map synchronization, see Code Map Synchronization Code Samples.

Syntax: Here is the method signature:

public EntitlementRefreshInfo refreshCodeMap(String entitlementDN rbpm-refresh-rate="value" freeform-param="value")
           throws NrfServiceException, RemoteException;

The parameters are described below:

  • entitlementDN entitlement DN to refresh the code map

    For example:

    cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system
  • rbpm-refresh-rate allows you to control the automatic or manual rate at which the entitlement is refreshed. Specify 0 to disable automatic refreshing. Specify -111111 to disable both automatic and manual refreshing.

  • freeform-param allows you to control whether the code map refresh removes entries from the database when the entitlement type is valued and the values were loaded directly into the database. Specify false if you do not want the refresh to remove the values from the database. Specify true if you want the refresh to remove the values from the database. The default value is true.

SOAP Request: Here is the SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.netiq.com/resource/service">
<soapenv:Header/>
<soapenv:Body>
<ser:refreshCodeMapRequest>
<!--Optional:-->
<ser:entitlementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</ser:entitlementDN>
</ser:refreshCodeMapRequest>
</soapenv:Body>
</soapenv:Envelope>

SOAP Response: Here is the SOAP request:

<SOAP-ENV:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body>
      <ns1:refreshCodeMapResponse xmlns="http://www.netiq.com/resource/service" xmlns:ns1="http://www.netiq.com/resource/service">
         <result>
            <detailedStatus>
               <codemaprefreshstatus>
                  <connectionName xsi:nil="1"/>
                  <entitlementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</entitlementDN>
                  <guid>\2d\13\d1\a4\7b\99\d6\4c\03\9a\2d\13\d1\a4\7b\99</guid>
                  <lastRefresh>1329244784180</lastRefresh>
                  <status>SUCCESS</status>
               </codemaprefreshstatus>
            </detailedStatus>
            <entitlementDN>cn=groups,cn=groupentitlementloopback,cn=driverset1,o=system</entitlementDN>
            <guid>\2d\13\d1\a4\7b\99\d6\4c\03\9a\2d\13\d1\a4\7b\99</guid>
            <status>true</status>
         </result>
      </ns1:refreshCodeMapResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

removeResource

Deletes a specified resource from the Resource Catalog. Returns the DN for the deleted resource as a confirmation.

A correlation ID is generated automatically for this method that uses this format:

UserApp#RemoteResourceRequest#xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

The correlation ID is used for auditing.

Syntax: Here is the method signature:

 public DNString removeResource(DNString resourceDn)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resourceDn specifies the DN of the resource to delete.

removeResourceAid

Deletes a specified resource from the Resource Catalog, with a correlation ID that you provide. The correlation ID is used for auditing to link a set of related resources. This method returns the DN for the deleted resource as a confirmation.

Syntax: Here is the method signature:

 public DNString removeResourceAid(DNString resourceDn, String correlation Id)
            throws NrfServiceException, RemoteException;

requestResourceGrant

Makes a grant resource request and returns a resource request correlation ID.

Syntax: Here is the method signature:

public String requestResourceGrant(String resourceTarget, String requester, String userTarget, String reasonForRequest,
        ResourceRequestParam[] requestParams, String correlationId)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resourceTarget specifies the target resource DN.

  • requester supplies an identifier for the remote client application making the request to grant the resource.

    The requester parameter on this SOAP endpoint identifies the originator of the request. This value is set in the resource request object nrfOriginator attribute, following this convention:

    • For a SOAP call: REMOTE_CLIENT:<requester param value>

    • For a workflow action: WF:<wf process id>

  • userTarget specifies the DN for the being granted the resource.

  • reasonForRequest provides a reason for the request.

  • requestParams provides the parameter values for the request.

  • correlationId specifies a resource assignment request correlation ID; if the parameter is null, a correlation ID is generated.

The requester parameter is a client-supplied identifier for the agent making the request. For example, an identifier such as IRemote-MyApplicationName might be used to identify a request from MyApplicationName. The requestParams are the dynamic parameter values required by the resource to make a request. If no values are required, the parameter value can be null or an empty array. The correlationId allows a client to group request for the purpose of checking the staus. If the parameter value is null, the service generates a unique correlation id. The correlation id is returned to the caller.

requestResourceRevoke

Makes a revoke resource request and returns a resource request correlation ID.

The revoke invocation behavior mirrors the behavior for a grant opeation, except that a revoke request for the resource is posted on the server.

Syntax: Here is the method signature:

public String requestResourceRevoke(String resourceTarget, 
           String requester, String userTarget, String reasonForRequest,
           ResourceRequestParam[] requestParams, String instanceGuid, String correlationId)
        throws NrfServiceException, RemoteException;

The parameters are described below:

  • resourceTarget specifies the target resource DN.

  • requester supplies an identifier for the remote client application making the request to revoke the resource.

    The requester parameter on this SOAP endpoint identifies the originator of the request. This value is set in the resource request object nrfOriginator attribute, following this convention:

    • For a SOAP call: REMOTE_CLIENT:<requester param value>

    • For a workflow action: WF:<wf process id>

    • For the identity applications user interface: USER_APP

  • userTarget specifies the DN for the user being granted the resource.

  • reasonForRequest provides a reason for the request.

  • requestParams provides the parameter values for the request.

  • instanceGuid provides a GUID identifier for the resource assignment instance. The resource assignment instance GUID supports revoking a single instance of a multi-value resource assignment, if not all instances are to be revoked.

    IMPORTANT:If you do not specify the instanceGuid value, and the user has more than one value of that resource assigned, all instances of the resource assignment will be removed.

    When you create a new resource assignment request, the instanceGuid is included just above the correlationid field:

    <ser:instanceGuid></ser:instanceGuid>

    You need to specify the instance of the resource you want to revoke by supplying the value in the instanceGuid parameter.

    To find out which resources are assigned to a user, you need to use the getResourceAssignmentsForUser method. This method returns the following data structure, which also includes the instanceGuid:

    <resourceassignment>
                   <instanceGuid>1b335aa9f4a14bd4a2a802eb4ba092da</instanceGuid>
                   <reason>3b-Test</reason>
                   <recipientDn>cn=ablake,ou=users,o=data</recipientDn>
                   <requestDate>2011-08-18T14:25:21</requestDate>
                   <requestParams>
                      <resourcerequestparam>
                         <name>param1</name>
                         <value>3a3a</value>
                      </resourcerequestparam>
                   </requestParams>
                   <requesterDn>cn=uaadmin,ou=sa,o=data</requesterDn>
                  
    <resourceDn>cn=Vodacom,cn=ResourceDefs,cn=RoleConfig,cn=AppConfig,cn=User
    Application Driver,cn=driverset1,o=system</resourceDn>
     </resourceassignment>
  • correlationId specifies a resource assignment request correlation ID; if the parameter is null, a correlation ID is generated.

setResourceLocalizedStrings

Sets the localized strings for a resource, such as the names and descriptions.

A correlation ID is generated automatically for this method that uses this format:

UserApp#RemoteResourceRequest#xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Syntax: Here is the method signature:

public LocalizedValue[] setResourceLocalizedStrings(String resourceDn, LocalizedValue[] locStrings, int type)
            throws NrfServiceException, RemoteException;

The parameters are described below:

  • resourceDn specifies the DN of the resource for which you want to set the localized strings.

  • locStrings provides an array of localized strings you want to define.

  • type specifies the type of localized strings you want to retrieve. A type value of 1 retrieves a list of names for the resource, whereas a type value of 2 retrieves a list of descriptions.

setResourceLocalizedStringsAid

Sets the localized strings for a resource, such as the names and descriptions, with a correlation ID that you provide. The correlation ID is used for auditing to link a set of related resources.

Syntax: Here is the method signature:

public LocalizedValue[] setResourceLocalizedStringsAid(String resourceDn, LocalizedValue[] locStrings, int type, String correlationId)
            throws NrfServiceException, RemoteException;

31.2.2 CodeMapRefreshStatus

Supporting class that provides details about the status of a code map refresh.

getConnectionName

Returns the name of the connected system.

Syntax: Here is the method signature:

public String getConnectionName()

getEntitlementDN

Returns the DN for the entitlement.

Syntax: Here is the method signature:

public String getEntitlementDN()

getGuid

Returns the GUID for the entitlement.

Syntax: Here is the method signature:

public String getGuid()

getLastRefresh

Returns the timestamp for the last refresh.

Syntax: Here is the method signature:

public long getLastRefresh()

getStatus

Returns the refresh status as a string indicating whether the refresh was successful.

Syntax: Here is the method signature:

public String getStatus()

setConnectionName

Sets the name of the connection system.

Syntax: Here is the method signature:

public void setConnectionName(final String connectionName)

setEntitlementDN

Sets the entitlement DN.

Syntax: Here is the method signature:

public void setEntitlementDN(String entitlementDN)

setGuid

Sets the GUID for the entitlement.

Syntax: Here is the method signature:

public void setGuid(String guid)

setLastRefresh

Sets the last refresh timestamp.

Syntax: Here is the method signature:

public void setLastRefresh(final long lastRefresh)

setStatus

Sets the refresh status.

Syntax: Here is the method signature:

public void setStatus(String status)

31.2.3 CodeMapValueStatus

Supporting class that provides details about the status of a refresh for a code map value.

getUpToDate

Returns true or false to indicate whether the status is up-to-date.

Syntax: Here is the method signature:

public boolean getUpToDate()

getRefreshStatus

Returns the refresh status as a CodeMapRefreshStatus object.

Syntax: Here is the method signature:

public CodeMapRefreshStatus getRefreshStatus()

getValue

Gets the code map value.

Syntax: Here is the method signature:

public String getValue()

setRefreshStatus

Sets the refresh as a CodeMapRefreshStatus object.

Syntax: Here is the method signature:

public void setRefreshStatus(final CodeMapRefreshStatus refreshStatus)

setUpToDate

Sets a boolean indicating whether the status is up-to-date.

Syntax: Here is the method signature:

public void setUpToDate(final boolean upToDate)

setValue

Sets the code map value.

Syntax: Here is the method signature:

public void setValue(final String value)

31.2.4 EntitlementRefreshInfo

Supporting class that provides refresh information for an entitlement after a code map refresh has been performed.

getDetailedStatus

Returns the detailed status as an array of CodeMapRefreshStatus objects.

Syntax: Here is the method signature:

public CodeMapRefreshStatus[] getDetailedStatus()

getEntitlementDN

Returns the DN for the entitlement.

Syntax: Here is the method signature:

public String getEntitlementDN()

getGuid

Returns the GUID for the entitlement.

Syntax: Here is the method signature:

public String getGuid()

getStatus

Returns the status of the refresh as a boolean flag.

Syntax: Here is the method signature:

public boolean getStatus()

setDetailedStatus

Sets the detailed status as an array of CodeMapRefreshStatus objects.

Syntax: Here is the method signature:

public void setDetailedStatus(final CodeMapRefreshStatus[] detailedStatus)

setEntitlementDN

Sets the DN for the entitlement.

Syntax: Here is the method signature:

public void setEntitlementDN(String entitlementDN)

setGuid

Sets the GUID for the entitlement.

Syntax: Here is the method signature:

public void setGuid(String m_guid)

setStatus

Sets the status as a boolean flag.

Syntax: Here is the method signature:

public void setStatus(boolean m_status)

31.2.5 ProvisioningCodeMap

Value class to hold code map information from the code map and code map label tables.

getDescription

Returns the description

public String getDescription()

getName

Returns the name.

public String getName()

getEntityKey

Returns the entity key.

public String getEntityKey()

getEntityType

Returns the entity type.

public int getEntityType()

getQueryKey

Returns the query key.

public String getQueryKey()

getViewId

Returns the view ID.

public String getViewId()

getLastRefreshed

Returns the timestamp for the last refresh.

public long getLastRefreshed()

setDescription

Sets the description.

public void setDescription(String description)

setName

Sets the name.

public void setName(String name)

setEntityKey

Sets the entity key.

public void setEntityKey(String entityKey)

setEntityType

Sets the entity type.

public void setEntityType(int entityType)

setQueryKey

Sets the query key.

public void setQueryKey(String queryKey)

setViewId

Sets the view ID.

public void setViewId(String viewId)

setLastRefreshed

Sets the timestamp for the last refresh.

public void setLastRefreshed(long lastRefreshed)

getLabels

Returns the code map labels.

public ProvisioningCodeMapLabel[] getLabels()

setLabels

Sets the code map labels.

public void setLabels(ProvisioningCodeMapLabel[] labels)

getEntitlementDn

Returns the DN for the entitlement.

public String getEntitlementDn()

setEntitlementDn

Sets the DN for the entitlement.

public void setEntitlementDn(String entitlementDn)

getDriverDn

Returns the DN for the driver.

public String getDriverDn()

setDriverDn

Sets the DN for the driver.

public void setDriverDn(String driverDn)

getDriverDisplayName

Returns the display name for the driver.

public String getDriverDisplayName()

setDriverDisplayName

Sets the display name for the driver.

public void setDriverDisplayName(String driverDisplayName)

31.2.6 Resource

Supporting class that provides information about resources.

getName

Returns the name of the resource.

public String getName()

setName

Sets the name of the resource.

public void setName(String name)

getDescription

Returns the description of the resource.

public String getDescription()

setDescription

Sets the description of the resource.

public void setDescription(String description)

getEntityKey

Returns the entity key for the resource.

public String getEntityKey()

setEntityKey

Sets the entity key for the resource.

public void setEntityKey(String entityKey)

getResourceCategoryKeys

Returns the keys for the resource categories.

public CategoryKey[] getResourceCategoryKeys()

setResourceCategoryKeys

Sets the keys for the resource categories.

public void setResourceCategoryKeys(CategoryKey[] resourceCategoryKeys)

getEntitlementRef

Returns the entitlement reference for the resource.

public NrfEntitlementRef[] getEntitlementRef()

setEntitlementRef

Sets the entitlement reference for the resource.

public void setEntitlementRef(NrfEntitlementRef[] entitlementRef)

getGrantApprovers

Returns the list of approvers for resource grant operations.

public Approver[] getGrantApprovers()

setGrantApprovers

Sets the list of approvers for resource grant operations.

public void setGrantApprovers(Approver[] grantApprovers)

getGrantQuorum

Returns the quorum condition for grant operations.

public String getGrantQuorum()

setGrantQuorum

Sets the quorum condition for grant operations.

public void setGrantQuorum(String grantQuorum)

getGrantRequestDef

Returns the provisioning request definition for grant operations.

public String getGrantRequestDef()

setGrantRequestDef

Sets the provisioning request definition for grant operations.

public void setGrantRequestDef(String grantRequestDef)

getRevokeQuorom

Returns the quorum condition for revoke operations.

public String getRevokeQuorum()

setRevokeQuorom

Sets the quorum condition for revoke operations.

public void setRevokeQuorum(String revokeQuorum)

getRevokeRequestDef

Returns the provisioning request definition for revoke operations.

public String getRevokeRequestDef()

setRevokeRequestDef

Sets the provisioning request definition for revoke operations.

public void setRevokeRequestDef(String revokeRequestDef)

getRevokeApprovers

Returns the list of approvers for revoke operations.

public Approver[] getRevokeApprovers()

setRevokeApprovers

Sets the list of approvers for revoke operations.

public void setRevokeApprovers(Approver[] revokeApprovers)

getOwners

Returns the list of owners for the resource.

public DNString[] getOwners()

setOwners

Sets the list of owners for the resource.

public void setOwners(DNString[] owners)

getParameters

Returns the list of entitlement parameters defined for the resource.

public ResourceParameter[] getParameters()

setParameters

Sets the list of entitlement parameters for the resource.

public void setParameters(ResourceParameter[] parameters)

getActive

Returns a boolean flag indicating whether the resource is still active, or has been approved or denied.

public boolean getActive()

setActive

Sets the boolean flag indicating whether the resource is still active.

public void setActive(final boolean active)

getAllowOverride

Returns a boolean flag indicating whether the approval process for the resource can be overridden by the approval process for a role.

public boolean getAllowOverride()

setAllowOverride

Sets the boolean flag indicating whether the approval process for the resource can be overridden by the approval process for a role.

public void setAllowOverride(final boolean allowOverride)

getAllowMulty

Returns a boolean indicating whether the resource allows a user to request multiple resource values.

public boolean getAllowedMulty()

setAllowMulty

Sets the boolean indicating whether the resource allows a user to request multiple resource values.

public void setAllowedMulty(final boolean allowedMulty)

31.2.7 ResourceAssignment

Supporting class that holds resource assignment information.

setResourceDn

Sets the DN for the resource.

public void setResourceDn(String resourceDn)

getResourceDn

Returns the DN for the resource.

public String getResourceDn()

setRequesterDn

Sets the DN for the requester.

public void setRequesterDn(String requesterDn)

getRequesterDn

Returns the DN for the requester.

public String getRequesterDn()

getRecipientDn

Returns the DN for the recipient of the assignment.

public String getRecipientDn()

setRecipientDn

Sets the DN for the recipient of the assignment.

public void setRecipientDn(String recipientDn)

getReason

Returns the reason for the assignment.

public String getReason()

setReason

Sets the reason for the assignment.

public void setReason(String reason)

getRequestDate

Returns the date of the assignment request.

public Date getRequestDate()

setRequestDate

Sets the date of the assignment request.

public void setRequestDate(Date requestDate)

setRequestParams

Sets the parameters for the request.

public void setRequestParams(ResourceRequestParam[] params)

getRequestParams

Returns the parameters for the request.

public ResourceRequestParam[] getRequestParams()

setInstanceGuid

Sets the instanceGuid for the resource assignment.

public void setInstanceGuid(String instanceGuid)

getInstanceGuid

Returns the instanceGuid for the resource assignment.

public String getInstanceGuid()

31.2.8 ResourceRequestParam

Supporting class that holds the name and value for a resource request parameter value.

ResourceRequestParam Constructors

The ResourceRequestParam class has two constructors.

Syntax 1: Here is the syntax for a constructor that takes no parameters:

public ResourceRequestParam() 
    {        
    }

Syntax 2: Here is the syntax for a constructor that takes two String parameters:

public ResourceRequestParam(String name, String value) 
    {   
        m_name = name;
        m_value = value;
    }

setName

Sets a parameter name.

Syntax: Here is the method signature:

public void setName(String name)

getName

Returns a parameter name.

Syntax: Here is the method signature:

public String getName()

setValue

Sets the value of a parameter.

Syntax: Here is the method signature:

public void setValue(String value)

getValue

Returns the value of a parameter.

Syntax: Here is the method signature:

public String getValue()

31.2.9 ResourceAssignmentRequestStatus

Supporting class that holds a resource request status item. The interface includes methods for getting and setting various request status properties. However, you will not need to call the methods for setting property values, since you are using this class to retrieve information about the request status. After calling the requestResourceGrant() or the requestResourceRevoke() methods, you can use the get methods to get the properties for each status object returned in the ResourceAssignmentRequestStatus array.

setEntityKey

Sets the entity key.

Syntax: Here is the method signature:

public void setEntityKey(String entityKey)

getEntityKey

Gets the entity key.

Syntax: Here is the method signature:

public String getEntityKey()

setReason

Sets the reason for the role assignment.

Syntax: Here is the method signature:

public void setReason(String reason)

getReason

Gets the reason for the role assignment.

Syntax: Here is the method signature:

public String getReason()

setStatusValue

Sets the status value for the request.

Syntax: Here is the method signature:

public void setStatusValue(int value)

setStatusDescription

Sets the status description for the request.

Syntax: Here is the method signature:

public void setStatusDescription(String description)

getStatusValue

Gets the status value for the request.

Syntax: Here is the method signature:

public int getStatusValue()

getStatusDescription

Gets the localized description for the request.

Syntax: Here is the method signature:

public String getStatusDescription()

setCorrelationId

Sets the correlation ID.

Syntax: Here is the method signature:

public void setCorrelationId(String correlationId)

getCorrelationId

Gets the correlation ID.

Syntax: Here is the method signature:

public String getCorrelationId()

setRequester

Sets the requester DN.

Syntax: Here is the method signature:

public void setRequester(String requester)

getRequester

Gets the requester DN.

Syntax: Here is the method signature:

public String getRequester()

setRequestDate

Sets the request date.

Syntax: Here is the method signature:

public void setRequestDate(Date requestDate)

getRequestDate

Gets the request date.

Syntax: Here is the method signature:

public Date getRequestDate()

setSource

Sets the source resource DN.

Syntax: Here is the method signature:

public void setSource(String source)

getSource

Gets the source resource DN.

Syntax: Here is the method signature:

public String getSource()

setTarget

Sets the DN for the target identity.

Syntax: Here is the method signature:

public void setTarget(String target)

getTarget

Gets the DN for the target identity.

Syntax: Here is the method signature:

public String getTarget()

setRequestParams

Sets the dynamic request parameters.

Syntax: Here is the method signature:

public void setRequestParams(ResourceRequestParam[] params)

getRequestParams

Gets the dynamic request parameters.

Syntax: Here is the method signature:

public ResourceRequestParam[] getRequestParams()