|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for managing channels.
Method Summary | |
void |
add(Channel channel)
Creates a new channel in the database. |
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)
|
java.lang.String[] |
listChannels()
List all existing channels. |
java.lang.String[] |
listManagers(java.lang.String channelName)
Lists all managers of a given channel. |
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 |
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 |
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 |
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 |
setTCPBufferSize2(java.lang.String channelName,
java.lang.String bufferSizeString,
java.lang.String message)
Set the TCP bufer size for the channel. |
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 |
public 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
public 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)public 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
public Channel2 getChannel2(java.lang.String channelName) throws AuthorizationException, NotExistsException, InternalException
AuthorizationException
NotExistsException
InternalException
public java.lang.String[] listChannels() throws AuthorizationException, InternalException
AuthorizationException
- Not allowed to list channels on service
InternalException
- Any other error (server side)public 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)public 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)public 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
public void setNumberOfStreams2(java.lang.String channelName, int numberOfStreams, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
public 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
public void setNumberOfFiles2(java.lang.String channelName, int numberOfFiles, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
public 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
public void setState2(java.lang.String channelName, java.lang.String state, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
public 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
public void setBandwidth2(java.lang.String channelName, int utilisation, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
public 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
public void setContact2(java.lang.String channelName, java.lang.String contact, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
public 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
public void setNominalThroughput2(java.lang.String channelName, int nominalThroughput, java.lang.String message) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
public 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
public 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)public 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)public 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)public 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)public 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)public 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |