|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChannelManagement
Interface for managing channels.
Method Summary | |
---|---|
void |
add(Channel channel)
Creates a new channel in the database. |
void |
addGroupMember(java.lang.String groupName,
java.lang.String siteName)
Add the site with given name to members of the given group. |
void |
addManager(java.lang.String channelName,
java.lang.String principal)
Adds a manager to the given channel. |
void |
changeStateForHeldJob(java.lang.String jobID,
java.lang.String state)
Manual intervention command on channel. |
void |
changeStateForHeldJobsOnChannel(java.lang.String channelName,
java.lang.String state)
Manual intervention command on channel. |
ChannelAuditEntry[] |
channelAudit(java.util.Calendar startTime,
java.util.Calendar endTime,
java.lang.String restrictType,
int lastNentries,
java.lang.String channelName)
Returns the channel audit information for a channel |
void |
drop(java.lang.String name)
Delete a channel. |
Channel |
getChannel(java.lang.String channelName)
Get the description of the given channel. |
Channel2 |
getChannel2(java.lang.String channelName)
|
Channel3 |
getChannel3(java.lang.String channelName)
|
java.lang.String[] |
getSiteGroupMembers(java.lang.String groupName)
Get the list of the members of the site group with given name |
java.lang.String[] |
getSiteGroupNames()
Get a list of the names of the defined site groups. |
java.lang.String[] |
listChannels()
List all existing channels. |
java.lang.String[] |
listManagers(java.lang.String channelName)
Lists all managers of a given channel. |
void |
removeGroupMember(java.lang.String groupName,
java.lang.String siteName)
Remove the site with given name from members of the given group. |
void |
removeManager(java.lang.String channelName,
java.lang.String principal)
Removes a manager from the given channel. |
void |
setBandwidth(java.lang.String channelName,
int utilisation)
Set the capacity bandwidth (Mbits/s). |
void |
setBandwidth2(java.lang.String channelName,
int utilisation,
java.lang.String message)
|
void |
setBlockSize(java.lang.String channelName,
java.lang.String blockSize,
java.lang.String message)
Sets the default block size of a transfer, e.g. '1MB' or '1024kb'. |
void |
setChannelType(java.lang.String channelName,
java.lang.String channelType,
java.lang.String message)
Sets the type of a channel: DEDICATED (point-to-point, seLimit is not considered) or NONDEDICATED (start or cloud). |
void |
setContact(java.lang.String channelName,
java.lang.String contact)
Set the contact email for a channel. |
void |
setContact2(java.lang.String channelName,
java.lang.String contact,
java.lang.String message)
|
void |
setHttpTimeout(java.lang.String channelName,
int httpTimeout,
java.lang.String message)
Sets the timeouts are in seconds. |
void |
setNominalThroughput(java.lang.String channelName,
int nominalThroughput)
Set the nominal throughtput target for the channel. |
void |
setNominalThroughput2(java.lang.String channelName,
int nominalThroughput,
java.lang.String message)
|
void |
setNumberOfFiles(java.lang.String channelName,
int numberOfFiles)
Utility method to set the number of concurrent files on a channel |
void |
setNumberOfFiles2(java.lang.String channelName,
int numberOfFiles,
java.lang.String message)
|
void |
setNumberOfStreams(java.lang.String channelName,
int numberOfStreams)
Utility method to set the number of concurrent streams on a channel. |
void |
setNumberOfStreams2(java.lang.String channelName,
int numberOfStreams,
java.lang.String message)
|
void |
setPreparingFilesRatio(java.lang.String channelName,
double preparingFilesRatio,
java.lang.String message)
Sets the ratio of SRM activity to number of transfer slots. |
void |
setSrmCopyDirection(java.lang.String channelName,
java.lang.String srmCopyDirection,
java.lang.String message)
Sets the sRM copy direction: PUSH, PULL. |
void |
setSrmCopyRefreshTimeout(java.lang.String channelName,
int srmCopyRefreshTimeout,
java.lang.String message)
Sets the timeout between status updates. |
void |
setSrmCopyTimeout(java.lang.String channelName,
int srmCopyTimeout,
java.lang.String message)
Sets the this is a global timeout. |
void |
setState(java.lang.String channelName,
java.lang.String state)
Set the operational state of a channel. |
void |
setState2(java.lang.String channelName,
java.lang.String state,
java.lang.String message)
|
void |
setTargetDirCheck(java.lang.String channelName,
int TargetDirCheck,
java.lang.String message)
Sets a flag if to check the target directory existence. |
void |
setTCPBufferSize2(java.lang.String channelName,
java.lang.String bufferSizeString,
java.lang.String message)
Set the TCP bufer size for the channel. |
void |
setTransferLogLevel(java.lang.String channelName,
java.lang.String transferLogLevel,
java.lang.String message)
Sets the possible values are: DEBUG, INFO (default), ERROR. |
void |
setUrlCopyFirstTxmarkTo(java.lang.String channelName,
int UrlCopyFirstTxmarkTo,
java.lang.String message)
Sets number of seconds to mark activity on URL Copy for a given channel. |
void |
setUrlCopyGetDoneTimeout(java.lang.String channelName,
int urlCopyGetDoneTimeout,
java.lang.String message)
Sets the url copy get done timeout. |
void |
setUrlCopyGetTimeout(java.lang.String channelName,
int urlCopyGetTimeout,
java.lang.String message)
Sets the url copy get timeout. |
void |
setUrlCopyNoProgressTimeout(java.lang.String channelName,
int urlCopyNoProgressTimeout,
java.lang.String message)
Sets the make dCache happy timeout. |
void |
setUrlCopyPutDoneTimeout(java.lang.String channelName,
int urlCopyPutDoneTimeout,
java.lang.String message)
Sets the url copy put done timeout. |
void |
setUrlCopyPutTimeout(java.lang.String channelName,
int urlCopyPutTimeout,
java.lang.String message)
Sets the url copy put timeout. |
void |
setUrlCopyTransferMarkersTimeout(java.lang.String channelName,
int urlCopyTransferMarkersTimeout,
java.lang.String message)
Sets the url copy transfer markers timeout. |
void |
setUrlCopyTransferTimeout(java.lang.String channelName,
int urlCopyTransferTimeout,
java.lang.String message)
Sets the url copy transfer timeout. |
void |
setUrlCopyTransferTimeoutPerMB(java.lang.String channelName,
double urlCopyTransferTimeoutPerMB,
java.lang.String message)
Sets the transfer timeout per megabyte. |
void |
setVOLimit(java.lang.String channelName,
java.lang.String VOName,
int limit)
Sets the transfer limit for a VO on a given channel. |
void |
setVOShare(java.lang.String channelName,
java.lang.String VOName,
int share)
Sets the share of a VO on a given channel. |
Methods inherited from interface org.glite.data.transfer.ServiceBase |
---|
getInterfaceVersion, getSchemaVersion, getServiceMetadata, getVersion |
Method Detail |
---|
void add(Channel channel) throws AuthorizationException, ExistsException, InvalidArgumentException, InternalException
channel
- The initial channel description
AuthorizationException
- Not allowed to add a channel on the service
InvalidArgumentException
- The information for the new channel is invalid
InternalException
- Any other error (server side)
ExistsException
Channel
void drop(java.lang.String name) throws AuthorizationException, NotExistsException, InternalException
name
- the channel to delete.
AuthorizationException
- Not allowed to remove the channel on the service
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel getChannel(java.lang.String channelName) throws AuthorizationException, NotExistsException, InternalException
channelName
- The name of the channel to retrieve info
AuthorizationException
- Not allowed to get information about the channel
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
Channel2 getChannel2(java.lang.String channelName) throws AuthorizationException, NotExistsException, InternalException
AuthorizationException
NotExistsException
InternalException
Channel3 getChannel3(java.lang.String channelName) throws AuthorizationException, NotExistsException, InternalException
AuthorizationException
NotExistsException
InternalException
java.lang.String[] listChannels() throws AuthorizationException, InternalException
AuthorizationException
- Not allowed to list channels on service
InternalException
- Any other error (server side)void changeStateForHeldJob(java.lang.String jobID, java.lang.String state) throws AuthorizationException, NotExistsException, InternalException
jobID
- The jobId of the job where the 'Hold' files state should be changedstate
- The new state for the files
AuthorizationException
- Not allowed to update file states on given job
NotExistsException
- There is no job with such ID
InternalException
- Any other error (server side)void changeStateForHeldJobsOnChannel(java.lang.String channelName, java.lang.String state) throws AuthorizationException, NotExistsException, InternalException
channelName
- The channel name whose files state should be changedstate
- The new state for the files
AuthorizationException
- Not allowed to update file states for jobs on given channel
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)void setNumberOfStreams(java.lang.String channelName, int numberOfStreams) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infonumberOfStreams
- New value
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void setNumberOfStreams2(java.lang.String channelName, int numberOfStreams, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
void setNumberOfFiles(java.lang.String channelName, int numberOfFiles) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infonumberOfFiles
- New value
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void setNumberOfFiles2(java.lang.String channelName, int numberOfFiles, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
void setState(java.lang.String channelName, java.lang.String state) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infostate
- New state
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void setState2(java.lang.String channelName, java.lang.String state, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
void setBandwidth(java.lang.String channelName, int utilisation) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infoutilisation
- New bandwith
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void setBandwidth2(java.lang.String channelName, int utilisation, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
void setContact(java.lang.String channelName, java.lang.String contact) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infocontact
- New contacominal throughtput targett
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void setContact2(java.lang.String channelName, java.lang.String contact, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
void setNominalThroughput(java.lang.String channelName, int nominalThroughput) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infonominalThroughput
- New value
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void setNominalThroughput2(java.lang.String channelName, int nominalThroughput, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
void setTCPBufferSize2(java.lang.String channelName, java.lang.String bufferSizeString, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- Name of channel to update infobufferSizeString
- New value
AuthorizationException
- Not allowed to update info of given channel
InvalidArgumentException
- The new value given is invalid
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)Channel
void addManager(java.lang.String channelName, java.lang.String principal) throws AuthorizationException, InvalidArgumentException, NotExistsException, ExistsException, InternalException
channelName
- channel name on which to add the managerprincipal
- principal of the manager
AuthorizationException
- Not allowed to add manager on given channel
InvalidArgumentException
- The given principal is invalid
NotExistsException
- There is no channel with such a name
ExistsException
- Given principal is already a channel manager
InternalException
- Any other error (server side)void removeManager(java.lang.String channelName, java.lang.String principal) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel name from which to remove the managerprincipal
- principal to be removed
AuthorizationException
- Not allowed to remove manager on given channel
InvalidArgumentException
- The given principal is invalid
NotExistsException
- There is no channel with such a name, or principal is not a manager of channel
InternalException
- Any other error (server side)java.lang.String[] listManagers(java.lang.String channelName) throws AuthorizationException, NotExistsException, InternalException
channelName
- channel name for which to list managers
AuthorizationException
- Not allowed to list managers of given channel
NotExistsException
- There is no channel with such a name
InternalException
- Any other error (server side)void setVOShare(java.lang.String channelName, java.lang.String VOName, int share) throws AuthorizationException, NotExistsException, InvalidArgumentException, InternalException
channelName
- channel name for which to set the vo shareVOName
- vo for which to set the shareshare
- the share value (negative removes the vo from the channel share list)
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setVOLimit(java.lang.String channelName, java.lang.String VOName, int limit) throws AuthorizationException, NotExistsException, InvalidArgumentException, InternalException
channelName
- channel name for which to set the vo shareVOName
- vo for which to set the sharelimit
- the maximum number of transfers allowed for a VO
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)ChannelAuditEntry[] channelAudit(java.util.Calendar startTime, java.util.Calendar endTime, java.lang.String restrictType, int lastNentries, java.lang.String channelName) throws AuthorizationException, NotExistsException, InvalidArgumentException, InternalException
startTime
- the start time for the searchendTime
- the end time for the searchrestrictType
- restricts what channel update events are searched forchannelName
- the channel to search onlastNentries
- if set, will retrun only the top N entries
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyFirstTxmarkTo(java.lang.String channelName, int UrlCopyFirstTxmarkTo, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel name for which to set the vo shareUrlCopyFirstTxmarkTo
- number of seconds to take as a first activity window
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setTargetDirCheck(java.lang.String channelName, int TargetDirCheck, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel name for which to set the vo shareTargetDirCheck
- flag to check destination directory
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setChannelType(java.lang.String channelName, java.lang.String channelType, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel namechannelType
- type of a channel
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setBlockSize(java.lang.String channelName, java.lang.String blockSize, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameblockSize
- default block size of a transfer
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setHttpTimeout(java.lang.String channelName, int httpTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel namehttpTimeout
- timeouts are in seconds.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setTransferLogLevel(java.lang.String channelName, java.lang.String transferLogLevel, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nametransferLogLevel
- possible values are: DEBUG, INFO (default), ERROR.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setPreparingFilesRatio(java.lang.String channelName, double preparingFilesRatio, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel namepreparingFilesRatio
- ratio of SRM activity to number of transfer slots.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyPutTimeout(java.lang.String channelName, int urlCopyPutTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyPutTimeout
- url copy put timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyPutDoneTimeout(java.lang.String channelName, int urlCopyPutDoneTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyPutDoneTimeout
- url copy put done timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyGetTimeout(java.lang.String channelName, int urlCopyGetTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyGetTimeout
- url copy get timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyGetDoneTimeout(java.lang.String channelName, int urlCopyGetDoneTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyGetDoneTimeout
- url copy get done timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyTransferTimeout(java.lang.String channelName, int urlCopyTransferTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyTransferTimeout
- url copy transfer timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyTransferMarkersTimeout(java.lang.String channelName, int urlCopyTransferMarkersTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyTransferMarkersTimeout
- url copy transfer markers timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyNoProgressTimeout(java.lang.String channelName, int urlCopyNoProgressTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyNoProgressTimeout
- make dCache happy timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setUrlCopyTransferTimeoutPerMB(java.lang.String channelName, double urlCopyTransferTimeoutPerMB, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel nameurlCopyTransferTimeoutPerMB
- transfer timeout per megabyte.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setSrmCopyDirection(java.lang.String channelName, java.lang.String srmCopyDirection, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel namesrmCopyDirection
- sRM copy direction: PUSH, PULL.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setSrmCopyTimeout(java.lang.String channelName, int srmCopyTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel namesrmCopyTimeout
- this is a global timeout.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)void setSrmCopyRefreshTimeout(java.lang.String channelName, int srmCopyRefreshTimeout, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
channelName
- channel namesrmCopyRefreshTimeout
- timeout between status updates.
AuthorizationException
- Not allowed to set vo shares for given channel
InvalidArgumentException
- The value for share is invalid
NotExistsException
- There is no channel with such a name, or there is no VO with such a name
InternalException
- Any other error (server side)java.lang.String[] getSiteGroupNames() throws AuthorizationException, InternalException
AuthorizationException
- Not allowed to list groups on service.
InternalException
- Any other error (server side).java.lang.String[] getSiteGroupMembers(java.lang.String groupName) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
groupName
- the name of the group.
AuthorizationException
- Not allowed to list group members.
InvalidArgumentException
- The groupName parameter is invalid.
NotExistsException
- There is no group with such a name.
InternalException
- Any other error (server side).void addGroupMember(java.lang.String groupName, java.lang.String siteName) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
groupName
- the name of the group.siteName
- the name of the site.
AuthorizationException
- Not allowed to add group members.
InvalidArgumentException
- One of the provided parameters is invalid.
NotExistsException
- There is no group with such a name.
ExistsException
- Given site is already a member of the group.
InternalException
- Any other error (server side).void removeGroupMember(java.lang.String groupName, java.lang.String siteName) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
groupName
- the name of the group.siteName
- the name of the site.
AuthorizationException
- Not allowed to remove group members.
InvalidArgumentException
- One of the provided parameters is invalid.
NotExistsException
- There is no group with such a name or site is not member of given group.
InternalException
- Any other error (server side).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |