edu.internet2.middleware.grouperClient.ws

Class GrouperClientWs

java.lang.Object

edu.internet2.middleware.grouperClient.ws.GrouperClientWs

public class GrouperClientWs
extends Object

this is the client that all requests go through. if you add an instance field, make sure to add to copyFrom()

Field Summary

Fields

Modifier and Type	Field and Description
static String	mostRecentRequest keep a reference to the most recent for testing
static String	mostRecentResponse keep a reference to the most recent for testing
static String	READ_ONLY_FAILOVER_CONFIG_NAME readonly failover config name
static String	READ_WRITE_FAILOVER_CONFIG_NAME readwrite failover config name

Constructor Summary

Constructors

Constructor and Description
GrouperClientWs()

Method Summary

Modifier and Type	Method and Description
GrouperClientWs	assignContentType(String theContentType) assign the content type, defaults to xml
GrouperClientWs	assignWsEndpoint(String theWsEndpoint) endpoint to grouper WS, e.g.
GrouperClientWs	assignWsPass(String theWsPass) ws pass
GrouperClientWs	assignWsUser(String theWsUser) ws user
void	copyFrom(GrouperClientWs grouperClientWs) copy from the argument to this object
Object	executeService(String urlSuffix, Object toSend, String labelForLog, String clientVersion, boolean readOnly)
void	handleFailure(Object responseContainer, ResultMetadataHolder[] resultMetadataHolders, String resultMessage) if failure, handle it

Methods inherited from class java.lang.Object

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

Field Detail

mostRecentRequest

public static String mostRecentRequest

keep a reference to the most recent for testing

mostRecentResponse

public static String mostRecentResponse

keep a reference to the most recent for testing

READ_ONLY_FAILOVER_CONFIG_NAME

public static final String READ_ONLY_FAILOVER_CONFIG_NAME

readonly failover config name

See Also:

Constant Field Values

READ_WRITE_FAILOVER_CONFIG_NAME

public static final String READ_WRITE_FAILOVER_CONFIG_NAME

readwrite failover config name

See Also:

Constant Field Values

Constructor Detail

GrouperClientWs

public GrouperClientWs()

Method Detail

copyFrom

public void copyFrom(GrouperClientWs grouperClientWs)

copy from the argument to this object

Parameters:

grouperClientWs -

assignContentType

public GrouperClientWs assignContentType(String theContentType)

assign the content type, defaults to xml

Parameters:

theContentType -

Returns:

this for chaining

executeService

public Object executeService(String urlSuffix,
                             Object toSend,
                             String labelForLog,
                             String clientVersion,
                             boolean readOnly)

Parameters:

urlSuffix - e.g. groups/aStem:aGroup/members

toSend - is the bean which will transform into XML, or just a string of XML to send...

labelForLog - label if the request is logged to file

clientVersion -

readOnly - true if readonly, false if readwrite

Returns:

the response object

handleFailure

public void handleFailure(Object responseContainer,
                          ResultMetadataHolder[] resultMetadataHolders,
                          String resultMessage)

if failure, handle it

Parameters:

responseContainer - is the object that everything marshaled to

resultMetadataHolders -

resultMessage -

Throws:

GcWebServiceError - if there is a problem

assignWsEndpoint

public GrouperClientWs assignWsEndpoint(String theWsEndpoint)

endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest

Parameters:

theWsEndpoint -

Returns:

this for chaining

assignWsPass

public GrouperClientWs assignWsPass(String theWsPass)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsUser

public GrouperClientWs assignWsUser(String theWsUser)

ws user

Parameters:

theWsUser -

Returns:

this for chaining