com.goonit.imapi.jaxrs.servlet.isim
Class role

java.lang.Object
  com.goonit.imapi.jaxrs.servlet.isim.role

public class role
extends java.lang.Object

role is a RESTFul service which performs Create, Read, Update and Delete operations on Organizational Role Entities.

This class has a Path annotation with the value "/role/{roleDN}" which means the resource will be available at: http://<hostname>:<port>/<context root>/<servlet path>/role/{roleDN} For GET, POST and DELETE Methods the dnStr represents the DN of the Role For PUT (Create Create Role) dnStr is the DN of the Organization Container within which the user should be created.

Constructor Summary

role()

Method Summary

javax.ws.rs.core.Response	DELETE() Processes a DELETE (Role Delete) request and returns the ISIM process id of the request.
java.lang.String	GET(javax.servlet.http.HttpServletRequest requestObj, javax.servlet.http.HttpServletResponse responseObj, java.lang.String strDN) Processes a GET request and returns the stored message.
java.lang.String	POST(java.lang.String json, java.lang.String dnStr) Processes a POST (Role Update) request and returns the ISIM process id of the request.
javax.ws.rs.core.Response	PUT(byte[] incomingMessage) Processes a PUT (Role Create) request and returns the ISIM process id of the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

role

public role()

Method Detail

GET

public java.lang.String GET(@Context
                            javax.servlet.http.HttpServletRequest requestObj,
                            @Context
                            javax.servlet.http.HttpServletResponse responseObj,
                            java.lang.String strDN)
                     throws java.rmi.RemoteException,
                            com.ibm.itim.apps.ApplicationException

Processes a GET request and returns the stored message.

Returns:

the stored message

Throws:

com.ibm.itim.apps.ApplicationException

java.rmi.RemoteException

POST

public java.lang.String POST(java.lang.String json,
                             java.lang.String dnStr)

Processes a POST (Role Update) request and returns the ISIM process id of the request.

Parameters:

{dnStr} - the DN of the Organisation container within which the Organizational Role Entity should be created.

?date - Query String containing the scheduled date ("null" = submit now) e.g POST https://192.168.1.31/goonit/goonapi/role/erglobalid=2900003699897423756,ou=roles,erglobalid=00000000000000000000,ou=goonit,dc=com2 {"attributeValueMap":{"owner":{"name":"owner","values":["erglobalid=7137657446191039644,ou=0,ou=people,erglobalid=00000000000000000000,ou=goonit,dc=com2","erglobalid=2900003699897423756,ou=roles,erglobalid=00000000000000000000,ou=goonit,dc=com2"]},"erparent":{"name":"erparent","values":["erglobalid=00000000000000000000,ou=goonit,dc=com2"]},"erobjectprofilename":{"name":"erobjectprofilename","values":["MailGroup"]},"objectclass":{"name":"objectclass","values":["top","erRole","erManagedItem","erAccessItem"]},"erroleclassification":{"name":"erroleclassification","values":["role.classification.application"]},"erglobalid":{"name":"erglobalid","values":["6834206469475337160"]},"description":{"name":"description","values":["Doctor role for testing purposes"]},"eraccessname":{"name":

messageBody - DATA - A JSON Object representing the AttributeValueMap of the Person Entity being created. e.g.: - {"attributeValueMap": {"owner":{"name":"owner","values":["erglobalid=7137657446191039644,ou=0,ou=people,erglobalid=00000000000000000000,ou=goonit,dc=com2", "erglobalid=2900003699897423756,ou=roles,erglobalid=00000000000000000000,ou=goonit,dc=com2"]}, "erparent":{"name":"erparent","values":["erglobalid=00000000000000000000,ou=goonit,dc=com2"]}, "erobjectprofilename":{"name":"erobjectprofilename","values":["MailGroup"]}, "objectclass":{"name":"objectclass","values":["top","erRole","erManagedItem","erAccessItem"]}, "erroleclassification":{"name":"erroleclassification","values":["role.classification.application"]}, "erglobalid":{"name":"erglobalid","values":["6834206469475337160"]}, "description":{"name":"description","values":["Doctor role for testing purposes"]}, "eraccessname":{"name":"eraccessname","values":["Doctor"]}, "errolename":{"name":"errolename","values":["Doctor"]} }}

Returns:

the response received from ITIM

PUT

public javax.ws.rs.core.Response PUT(byte[] incomingMessage)

Processes a PUT (Role Create) request and returns the ISIM process id of the request.

Parameters:

{dnStr} - the DN of the Organisation container within which the Organizational Role Entity should be created.

?date - Query String containing the scheduled date ("null" = submit now)

messageBody - e.g PUT https://192.168.1.31/goonit/goonapi/role/erglobalid=6328172302732505759,ou=orgchart,erglobalid=00000000000000000000,ou=goonit,dc=com2 {"attributeValueMap":{"owner":{"name":"owner","values":["erglobalid=7137657446191039644,ou=0,ou=people,erglobalid=00000000000000000000,ou=goonit,dc=com2","erglobalid=2900003699897423756,ou=roles,erglobalid=00000000000000000000,ou=goonit,dc=com2"]},"erparent":{"name":"erparent","values":["erglobalid=00000000000000000000,ou=goonit,dc=com2"]},"erobjectprofilename":{"name":"erobjectprofilename","values":["MailGroup"]},"objectclass":{"name":"objectclass","values":["top","erRole","erManagedItem","erAccessItem"]},"erroleclassification":{"name":"erroleclassification","values":["role.classification.application"]},"erglobalid":{"name":"erglobalid","values":["6834206469475337160"]},"description":{"name":"description","values":["Doctor role for testing purposes"]},"eraccessname":{"name":

DATA - - A JSON Object representing the AttributeValueMap of the Person Entity being created. e.g.: - {"attributeValueMap": {"owner":{"name":"owner","values":["erglobalid=7137657446191039644,ou=0,ou=people,erglobalid=00000000000000000000,ou=goonit,dc=com2", "erobjectprofilename":{"name":"erobjectprofilename","values":["MailGroup"]}, "objectclass":{"name":"objectclass","values":["top","erRole","erManagedItem","erAccessItem"]}, "erroleclassification":{"name":"erroleclassification","values":["role.classification.application"]}, "description":{"name":"description","values":["Doctor role for testing purposes"]}, "eraccessname":{"name":"eraccessname","values":["Doctor"]}, "errolename":{"name":"errolename","values":["Doctor"]} }}

Returns:

the response received from ITIM

DELETE

public javax.ws.rs.core.Response DELETE()

Processes a DELETE (Role Delete) request and returns the ISIM process id of the request.

Parameters:

{dnStr} - the DN of the Organisation container within which the Organizational Role Entity should be created.

?date - Query String containing the scheduled date ("null" = submit now)

messageBody - e.g DELETE https://192.168.1.31/goonit/goonapi/role/erglobalid=2900003699897423756,ou=roles,erglobalid=00000000000000000000,ou=goonit,dc=com2

Returns:

the response received from ITIM