org.glite.data.transfer.stats
Interface FileTransferStats

All Superinterfaces:
ServiceBase

public interface FileTransferStats
extends ServiceBase

The service interface of the File Transfer Stats component. It exposes functionality to get statistics information on the File Transfer Service behaviour/usage.


Method Summary
 TransferActivity[] getChannelActivity(java.util.Calendar startTime, java.util.Calendar endTime, java.lang.String channelName, java.lang.String[] voNames)
          Returns the activity of the channel during a given interval of time.
 TransferSummary[] getChannelSummary(java.util.Calendar startTime, java.util.Calendar endTime, java.lang.String channelName, java.lang.String[] voNames)
          Returns the summary of channel usage of the service on a given interval of time.
 TransferAgent[] getTransferAgents()
          Returns the list of agents running on the service.
 TransferActivity[] getVOActivity(java.util.Calendar startTime, java.util.Calendar endTime, java.lang.String voName, java.lang.String[] channelNames)
          Returns the activity of the VO during a given interval of time.
 TransferSummary[] getVOSummary(java.util.Calendar startTime, java.util.Calendar endTime, java.lang.String voName, java.lang.String[] channelNames)
          Returns the summary of VO usage of the service on a given interval of time.
 
Methods inherited from interface org.glite.data.transfer.ServiceBase
getInterfaceVersion, getSchemaVersion, getServiceMetadata, getVersion
 

Method Detail

getChannelSummary

public TransferSummary[] getChannelSummary(java.util.Calendar startTime,
                                           java.util.Calendar endTime,
                                           java.lang.String channelName,
                                           java.lang.String[] voNames)
                                    throws AuthorizationException,
                                           InvalidArgumentException,
                                           ServiceBusyException,
                                           InternalException
Returns the summary of channel usage of the service on a given interval of time. A summary object contains the number of files/jobs in each possible state for a given VO on the channel. It is possible to give a null value for VO, meaning all VOs data should be retrieved. If both startTime and endTime are null or 0, then the latest statistic generated should be returned. If only startTime is not null or 0, then the closest statistic *after* startTime is given. If only endTime is not null or 0, then the closest statistic *before* endTime is given.

Parameters:
startTime - The earliest time of interest to return transfer summary snapshots.
endTime - The latest time of interest to return transfer summary snapshots.
channelName - The channel of interest for which summaries should be retrieved.
voNames - A list of VOs of interest for which summaries should be retrieved. Null means all VOs.
Returns:
A list of TransferSummary objects, each containing a summary taken at a specific time for a given VO on the channel.
Throws:
AuthorizationException
InvalidArgumentException
ServiceBusyException
InternalException

getVOSummary

public TransferSummary[] getVOSummary(java.util.Calendar startTime,
                                      java.util.Calendar endTime,
                                      java.lang.String voName,
                                      java.lang.String[] channelNames)
                               throws AuthorizationException,
                                      InvalidArgumentException,
                                      ServiceBusyException,
                                      InternalException
Returns the summary of VO usage of the service on a given interval of time. A summary object contains the number of files/jobs belonging to the VO in each possible state for a given channel . It is possible to give a null value for the channelNames, meaning all channels data should be retrieved. If both startTime and endTime are null or 0, then the latest statistic generated should be returned. If only startTime is not null or 0, then the closest statistic *after* startTime is given. If only endTime is not null or 0, then the closest statistic *before* endTime is given.

Parameters:
startTime - The earliest time of interest to return transfer summary snapshots.
endTime - The latest time of interest to return transfer summary snapshots.
voName - The VO of interest for which summaries should be retrieved.
channelNames - A list of channels of interest for which summaries should be retrieved. Null means all channels.
Returns:
A list of TransferSummary objects, each containing a summary taken at a specific time.
Throws:
AuthorizationException
InvalidArgumentException
ServiceBusyException
InternalException

getChannelActivity

public TransferActivity[] getChannelActivity(java.util.Calendar startTime,
                                             java.util.Calendar endTime,
                                             java.lang.String channelName,
                                             java.lang.String[] voNames)
                                      throws AuthorizationException,
                                             InvalidArgumentException,
                                             ServiceBusyException,
                                             InternalException
Returns the activity of the channel during a given interval of time. A activity object contains the bytesWritten and the average transfer rate on the channel during a given interval in time for a given VO. It is possible to give a null value for VO, meaning all VOs data should be retrieved. If both startTime and endTime are null or 0, then the latest statistic generated should be returned. If only startTime is not null or 0, then the closest statistic *after* startTime is given. If only endTime is not null or 0, then the closest statistic *before* endTime is given.

Parameters:
startTime - The earliest time of interest to return transfer activity periods.
endTime - The latest time of interest to return transfer activity periods.
channelName - The channel of interest for the activity.
voNames - A list of VOs of interest for which activity periods should be retrieved. Null means all VOs.
Returns:
A list of TransferActivity objects, each containing the activity values for a given vo/channel pair on a given interval.
Throws:
AuthorizationException
InvalidArgumentException
ServiceBusyException
InternalException

getVOActivity

public TransferActivity[] getVOActivity(java.util.Calendar startTime,
                                        java.util.Calendar endTime,
                                        java.lang.String voName,
                                        java.lang.String[] channelNames)
                                 throws AuthorizationException,
                                        InvalidArgumentException,
                                        ServiceBusyException,
                                        InternalException
Returns the activity of the VO during a given interval of time. A activity object contains the bytesWritten and the average transfer rate off the VO during a given interval in time on a given channel. It is possible to pass a null value for channel, meaning all channels data should be retrieved. If both startTime and endTime are null or 0, then the latest statistic generated should be returned. If only startTime is not null or 0, then the closest statistic *after* startTime is given. If only endTime is not null or 0, then the closest statistic *before* endTime is given.

Parameters:
startTime - The earliest time of interest to return transfer activity periods.
endTime - The latest time of interest to return transfer activity periods.
voName - The VO of interest for the activity.
channelNames - A list of channels of interest for which activity periods should be retrieved. Null means all channels.
Returns:
A list of TransferActivity objects, each containing the activity values for a given vo/channel pair on a given interval.
Throws:
AuthorizationException
InvalidArgumentException
ServiceBusyException
InternalException

getTransferAgents

public TransferAgent[] getTransferAgents()
Returns the list of agents running on the service. A TransferAgent object exposes both static and dynamic information about the agent (name, type, host, state, lastActive, ...).

Returns:
A list of TransferAgent objects, each corresponding to an agent running on the service.


Copyright © 2004 EU-EGEE