Package edu.internet2.middleware.grouperClient.api

Class GcDataProviderSubjectListSync

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcDataProviderSubjectListSync

public class GcDataProviderSubjectListSync
extends Object

class to sync a list of subjects from a data provider

Constructor Summary

Constructors

Constructor	Description
GcDataProviderSubjectListSync()

Method Summary

Modifier and Type	Method	Description
GcDataProviderSubjectListSync	addSubjectId(String subjectId, String sourceId)	add a subject lookup
GcDataProviderSubjectListSync	addSubjectIdentifier(String subjectIdentifier, String sourceId)	add a subject lookup
GcDataProviderSubjectListSync	addSubjectLookup(WsSubjectLookup wsSubjectLookup)	add a subject lookup
GcDataProviderSubjectListSync	assignActAsSubject(WsSubjectLookup theActAsSubject)	assign the act as subject if any
GcDataProviderSubjectListSync	assignClientVersion(String theClientVersion)	assign client version
GcDataProviderSubjectListSync	assignContentType(String theContentType)	content type for post request
GcDataProviderSubjectListSync	assignDataProviderConfigId(String theDataProviderConfigId)	assign the data provider config id
GcDataProviderSubjectListSync	assignWsEndpoint(String theWsEndpoint)	endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest
GcDataProviderSubjectListSync	assignWsPass(String theWsPass)	ws pass
GcDataProviderSubjectListSync	assignWsPassEncrypted(String theWsPassEncrypted)	ws pass
GcDataProviderSubjectListSync	assignWsPassFile(File theFile)	ws pass
GcDataProviderSubjectListSync	assignWsPassFileEncrypted(File theFile)	ws pass
GcDataProviderSubjectListSync	assignWsUser(String theWsUser)	ws user
WsDataProviderSubjectListSyncResult	execute()	execute the call and return the results.

Methods inherited from class java.lang.Object

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

Constructor Details

GcDataProviderSubjectListSync

public GcDataProviderSubjectListSync()

Method Details

assignWsEndpoint

public GcDataProviderSubjectListSync assignWsEndpoint(String theWsEndpoint)

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

Parameters:

theWsEndpoint -

Returns:

this for chaining

assignWsUser

public GcDataProviderSubjectListSync assignWsUser(String theWsUser)

ws user

Parameters:

theWsUser -

Returns:

this for chaining

assignWsPass

public GcDataProviderSubjectListSync assignWsPass(String theWsPass)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsPassEncrypted

public GcDataProviderSubjectListSync assignWsPassEncrypted(String theWsPassEncrypted)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsPassFile

public GcDataProviderSubjectListSync assignWsPassFile(File theFile)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsPassFileEncrypted

public GcDataProviderSubjectListSync assignWsPassFileEncrypted(File theFile)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignActAsSubject

public GcDataProviderSubjectListSync assignActAsSubject(WsSubjectLookup theActAsSubject)

assign the act as subject if any

Parameters:

theActAsSubject -

Returns:

this for chaining

assignDataProviderConfigId

public GcDataProviderSubjectListSync assignDataProviderConfigId(String theDataProviderConfigId)

assign the data provider config id

Parameters:

theDataProviderConfigId -

Returns:

this for chaining

addSubjectLookup

public GcDataProviderSubjectListSync addSubjectLookup(WsSubjectLookup wsSubjectLookup)

add a subject lookup

Parameters:

wsSubjectLookup -

Returns:

this for chaining

addSubjectId

public GcDataProviderSubjectListSync addSubjectId(String subjectId,
 String sourceId)

add a subject lookup

Parameters:

subjectId -

sourceId -

Returns:

this for chaining

addSubjectIdentifier

public GcDataProviderSubjectListSync addSubjectIdentifier(String subjectIdentifier,
 String sourceId)

add a subject lookup

Parameters:

subjectIdentifier -

sourceId -

Returns:

this for chaining

assignClientVersion

public GcDataProviderSubjectListSync assignClientVersion(String theClientVersion)

assign client version

Parameters:

theClientVersion -

Returns:

this for chaining

assignContentType

public GcDataProviderSubjectListSync assignContentType(String theContentType)

content type for post request

Parameters:

theContentType -

Returns:

this for chaining

execute

public WsDataProviderSubjectListSyncResult execute()

execute the call and return the results. If there is a problem calling the service, an exception will be thrown

Returns:

the results