org.glite.data.transfer.channel
Interface ChannelManagement

All Superinterfaces:
ServiceBase

public interface ChannelManagement
extends ServiceBase

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

add

public void add(Channel channel)
         throws AuthorizationException,
                ExistsException,
                InvalidArgumentException,
                InternalException
Creates a new channel in the database.

Parameters:
channel - The initial channel description
Throws:
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
See Also:
Channel

drop

public void drop(java.lang.String name)
          throws AuthorizationException,
                 NotExistsException,
                 InternalException
Delete a channel.

Parameters:
name - the channel to delete.
Throws:
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)

getChannel

public Channel getChannel(java.lang.String channelName)
                   throws AuthorizationException,
                          NotExistsException,
                          InternalException
Get the description of the given channel.

Parameters:
channelName - The name of the channel to retrieve info
Returns:
The Channel object holding the channel info
Throws:
AuthorizationException - Not allowed to get information about the channel
NotExistsException - There is no channel with such a name
InternalException - Any other error (server side)
See Also:
Channel

getChannel2

public Channel2 getChannel2(java.lang.String channelName)
                     throws AuthorizationException,
                            NotExistsException,
                            InternalException
Throws:
AuthorizationException
NotExistsException
InternalException

listChannels

public java.lang.String[] listChannels()
                                throws AuthorizationException,
                                       InternalException
List all existing channels.

Returns:
An array of strings containing the channel names
Throws:
AuthorizationException - Not allowed to list channels on service
InternalException - Any other error (server side)

changeStateForHeldJob

public void changeStateForHeldJob(java.lang.String jobID,
                                  java.lang.String state)
                           throws AuthorizationException,
                                  NotExistsException,
                                  InternalException
Manual intervention command on channel. It changes the file_state for all files belonging to the given job from Hold to the given file state. It will only work for files in the Hold state. The only permissible requested states are 'Pending', 'Failed' or 'Canceling'.

Parameters:
jobID - The jobId of the job where the 'Hold' files state should be changed
state - The new state for the files
Throws:
AuthorizationException - Not allowed to update file states on given job
NotExistsException - There is no job with such ID
InternalException - Any other error (server side)

changeStateForHeldJobsOnChannel

public void changeStateForHeldJobsOnChannel(java.lang.String channelName,
                                            java.lang.String state)
                                     throws AuthorizationException,
                                            NotExistsException,
                                            InternalException
Manual intervention command on channel. It changes the file_state for all files belonging to all jobs on the given channel which are in the Hold state to the given file state. It will only work for files in the Hold state. The only permissible requested states are 'Pending', 'Failed' or 'Canceling'.

Parameters:
channelName - The channel name whose files state should be changed
state - The new state for the files
Throws:
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)

setNumberOfStreams

public void setNumberOfStreams(java.lang.String channelName,
                               int numberOfStreams)
                        throws AuthorizationException,
                               InvalidArgumentException,
                               NotExistsException,
                               InternalException
Utility method to set the number of concurrent streams on a channel.

Parameters:
channelName - Name of channel to update info
numberOfStreams - New value
Throws:
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)
See Also:
Channel

setNumberOfStreams2

public void setNumberOfStreams2(java.lang.String channelName,
                                int numberOfStreams,
                                java.lang.String message)
                         throws AuthorizationException,
                                InvalidArgumentException,
                                NotExistsException,
                                InternalException
Throws:
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException

setNumberOfFiles

public void setNumberOfFiles(java.lang.String channelName,
                             int numberOfFiles)
                      throws AuthorizationException,
                             InvalidArgumentException,
                             NotExistsException,
                             InternalException
Utility method to set the number of concurrent files on a channel

Parameters:
channelName - Name of channel to update info
numberOfFiles - New value
Throws:
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)
See Also:
Channel

setNumberOfFiles2

public void setNumberOfFiles2(java.lang.String channelName,
                              int numberOfFiles,
                              java.lang.String message)
                       throws AuthorizationException,
                              InvalidArgumentException,
                              NotExistsException,
                              InternalException
Throws:
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException

setState

public void setState(java.lang.String channelName,
                     java.lang.String state)
              throws AuthorizationException,
                     InvalidArgumentException,
                     NotExistsException,
                     InternalException
Set the operational state of a channel.

Parameters:
channelName - Name of channel to update info
state - New state
Throws:
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)
See Also:
Channel

setState2

public void setState2(java.lang.String channelName,
                      java.lang.String state,
                      java.lang.String message)
               throws AuthorizationException,
                      InvalidArgumentException,
                      NotExistsException,
                      InternalException
Throws:
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException

setBandwidth

public void setBandwidth(java.lang.String channelName,
                         int utilisation)
                  throws AuthorizationException,
                         InvalidArgumentException,
                         NotExistsException,
                         InternalException
Set the capacity bandwidth (Mbits/s).

Parameters:
channelName - Name of channel to update info
utilisation - New bandwith
Throws:
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)
See Also:
Channel

setBandwidth2

public void setBandwidth2(java.lang.String channelName,
                          int utilisation,
                          java.lang.String message)
                   throws AuthorizationException,
                          InvalidArgumentException,
                          NotExistsException,
                          InternalException
Throws:
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException

setContact

public void setContact(java.lang.String channelName,
                       java.lang.String contact)
                throws AuthorizationException,
                       InvalidArgumentException,
                       NotExistsException,
                       InternalException
Set the contact email for a channel.

Parameters:
channelName - Name of channel to update info
contact - New contacominal throughtput targett
Throws:
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)
See Also:
Channel

setContact2

public void setContact2(java.lang.String channelName,
                        java.lang.String contact,
                        java.lang.String message)
                 throws AuthorizationException,
                        InvalidArgumentException,
                        NotExistsException,
                        InternalException
Throws:
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException

setNominalThroughput

public void setNominalThroughput(java.lang.String channelName,
                                 int nominalThroughput)
                          throws AuthorizationException,
                                 InvalidArgumentException,
                                 NotExistsException,
                                 InternalException
Set the nominal throughtput target for the channel.

Parameters:
channelName - Name of channel to update info
nominalThroughput - New value
Throws:
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)
See Also:
Channel

setNominalThroughput2

public void setNominalThroughput2(java.lang.String channelName,
                                  int nominalThroughput,
                                  java.lang.String message)
                           throws AuthorizationException,
                                  InvalidArgumentException,
                                  NotExistsException,
                                  InternalException
Throws:
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException

setTCPBufferSize2

public void setTCPBufferSize2(java.lang.String channelName,
                              java.lang.String bufferSizeString,
                              java.lang.String message)
                       throws AuthorizationException,
                              InvalidArgumentException,
                              NotExistsException,
                              InternalException
Set the TCP bufer size for the channel.

Parameters:
channelName - Name of channel to update info
bufferSizeString - New value
Throws:
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)
See Also:
Channel

addManager

public void addManager(java.lang.String channelName,
                       java.lang.String principal)
                throws AuthorizationException,
                       InvalidArgumentException,
                       NotExistsException,
                       ExistsException,
                       InternalException
Adds a manager to the given channel.

Parameters:
channelName - channel name on which to add the manager
principal - principal of the manager
Throws:
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)

removeManager

public void removeManager(java.lang.String channelName,
                          java.lang.String principal)
                   throws AuthorizationException,
                          InvalidArgumentException,
                          NotExistsException,
                          InternalException
Removes a manager from the given channel.

Parameters:
channelName - channel name from which to remove the manager
principal - principal to be removed
Throws:
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)

listManagers

public java.lang.String[] listManagers(java.lang.String channelName)
                                throws AuthorizationException,
                                       NotExistsException,
                                       InternalException
Lists all managers of a given channel.

Parameters:
channelName - channel name for which to list managers
Throws:
AuthorizationException - Not allowed to list managers of given channel
NotExistsException - There is no channel with such a name
InternalException - Any other error (server side)

setVOShare

public void setVOShare(java.lang.String channelName,
                       java.lang.String VOName,
                       int share)
                throws AuthorizationException,
                       NotExistsException,
                       InvalidArgumentException,
                       InternalException
Sets the share of a VO on a given channel. A negative value removes the VO share from the channel share list.

Parameters:
channelName - channel name for which to set the vo share
VOName - vo for which to set the share
share - the share value (negative removes the vo from the channel share list)
Throws:
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)

setVOLimit

public void setVOLimit(java.lang.String channelName,
                       java.lang.String VOName,
                       int limit)
                throws AuthorizationException,
                       NotExistsException,
                       InvalidArgumentException,
                       InternalException
Sets the transfer limit for a VO on a given channel. A negative value removes the VO limit from the channel limit list.

Parameters:
channelName - channel name for which to set the vo share
VOName - vo for which to set the share
limit - the maximum number of transfers allowed for a VO
Throws:
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)

channelAudit

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
Returns the channel audit information for a channel

Parameters:
startTime - the start time for the search
endTime - the end time for the search
restrictType - restricts what channel update events are searched for
channelName - the channel to search on
lastNentries - if set, will retrun only the top N entries
Returns:
an array of ChannelAuditEntry
Throws:
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)


Copyright © 2004 EU-EGEE