pipe contents of in to out

pipe contents of in to out

generate a date-stamp in format 'DD-MM-YY'

generate a date/time stamp in format 'DD-MM-YY-HHMMSS'

read contents of a stream

read contents of a stream

read contents of an external value

create an external value that points to a vospace uri

create an external value that points to a vospace uri

create an external value that points to a vosapce uri

access library object that 'knows' about a variety of IO protocols, and can construct {@link ExternalValue} objects to read / write resources via these protocols.

pipe contents of in to out

pipe contents of in to out

pipe contents of in to out

pipe contents of in to out

pipe contents of in to out

returns a reader of the contents of a string

returns a stream of the contents of a string

generate a time-stamp as a long number

helper method to create an account object

Params

• username name of the user
• community community the user is registered with

create a credentials object from an account and a group

create a group object *

Params

• groupName name of the group
• community community the group belongs to

construct an arbitrary ivorn object

Throws

• URISyntaxException

construct an abritray ivorn object

Params

• path the ivorn
• fragment a fragment - i.e. the bit after #

Returns an ivorn of form ivo://path#fragment

construct an abritray ivorn object

Params

• authority the authority of the ivorn
• key key into the authority
•  

Returns an ivorn of form ivo://authority/key#fragment

create a user ivorn, from account name and locally-configured community

Params

• account the username

Returns a user ivorn, where the comminity name is provided by local configuration

Throws

• CommunityServiceException is the commnity service can't be accessed
• CommunityIdentifierException

create a user

Params

• userid username
• community community the user is registered with
• group group the user belongs to
• token not used

create a user ivorn, from community and account name

Params

• community the name of the community the account is registered with
• account the username

Throws

• CommunityIdentifierException if the community is not known.

convert a user object into an ivorn that represents that user

Params

• u a user object

Returns the equivalent user ivorn.

Throws

• CommunityIdentifierException if the community is not known

create the anonymous user

access the table builder

access the STIL library object for writing out tables - see http://www.star.bristol.ac.uk/~mbt/stil/javadocs/uk/ac/starlink/table/StarTableOutput.html

create a new column info object - see http://www.star.bristol.ac.uk/~mbt/stil/javadocs/uk/ac/starlink/table/ColumnInfo.html

create a new column info object - see http://www.star.bristol.ac.uk/~mbt/stil/javadocs/uk/ac/starlink/table/ColumnInfo.html

create a new empty mutable table

create a new empty mutable table, with the same structure as a template table

access contents of a table as a stream

access contents of table as a string

Throws

• IOException

write star table to an external location

Throws

• InaccessibleExternalValueException
• IOException

create a CEA client connected to the specified service endpoint

client to administer the registry

client to query the registry

create a client to work with the vospace tree-model

Params

• acc the ivorn of the account to connect to
• password the password for this account

Returns a logged-in treeclient for this account

Throws

• TreeClientLoginException if login failed
• TreeClientServiceException if communication failed

create a client to access vospace

Params

• u object representing the user for whom to create the client for

Returns a vospace client which has the permissions of user u

helper object for working with IO

access a standard logging object

helper object for building account-type objects

Returns object that assists in building {@link User} objects, etc.

access library object that 'knows' about a variety of IO protocols, and can construct {@link ExternalValue} objects to read / write resources via these protocols.

access an object for building star tables from strngs, URLs and ExternalValues

accces the system configuration object

Returns the system configuration object

returns system information for the toolbox

helper object for building, manipulating and writing tables

returns version information for the toolbox

helper obect for building, saving, submitting and inspecting worflows.

Throws

• WorkflowInterfaceException

helper object for working with io

Returns object that assists with constructing and manipulatingn xml.

convert document to string

convert element to string

create new DOM Document

parse contents of input stream into document

parse contents of string into document

Return a new table, based on this one with an additional colum

Params

• meta metadata for the new column
• colValue a value that defines the column value. May either be a static {@link java.lang.reflect.Method}, of type Object method(Object[] arr). The method will be passed the values of the other cells in the row, and the result used as the value of the new cellan instance of {@link ColumnFunction} whose method will be called to define the value of the new cella groovy closure - which will be passed a single parameter - a list containing the values of the other cells in the row. The result returned by the closure will be used as the value of the new cell.any other object - in which case it is used as a constant value for every cell in this column.

Returns a new table, same as this one, with an extra column at the end.

Return a mutable copy of this table.

Returns a mutable table that has the same structure and contents as the current table.

Throws

• IOException

iterate over each cell in a column

Params

• col column to iterate over

Returns an iteratore that will return the value of each cell in this column.

Throws

• IOException

iterate over each row in the table.

Returns an iterator that will return a {@link java.util.List} of the cells in each row

Throws

• IOException

Return a new table, based on this table, but with one column removed

Params

• index index of the column to remove.

Returns a new table, based on this one, with one less column.

load the contents of a file / url into a scriptable star table

load the contents of a URL into a scriptable star table

load the contents of a URL into a scriptable star table

construct a star table from an external value

Params

• externalValue reference to a remote location

Returns a star table

Throws

• TableFormatException if table data is not in a known format
• IOException if remote location cannot be accessed

construct a star table from an external value

Params

• externalValue reference to a remote location
• format expected table format

Returns a star table

Throws

• TableFormatException if table data is not in expected format
• IOException if remote location cannot be accessed

construct a starTable from the contents of a string

construct a starTable from the contents of a string

return a guaranteed random-access scriptable star table

Writes out the configuration keys and values to the given Writer. Used for site debugging. Remember that passwords should be hidden...

Typed getProperty - returns boolean.

Typed getProperty - returns boolean.

Attempt to resolve deployment-specific name. In this case it looks at the url of this file

Indirect typed getProperty - returns a DOM loaded from a file at the url speficied. ie, looks up the given key to get a url, then attempts to read a DOM from the file at that URL.

Indirect typed getProperty - returns a DOM loaded from a file at the url speficied. ie, looks up the given key to get a url, then attempts to read a DOM from the file at that URL.

Indirect typed getProperty - returns a DOM loaded from a file at the url speficied. ie, looks up the given key to get a url, then attempts to read a DOM from the file at that URL.

Typed getProperty - returns integer. If property is not a valid int, throws a wrapping ConfigException as a runtime error

Typed getProperty - returns integer. If property is not a valid int, throws a wrapping ConfigException as a runtime error

Returns the list of properties identified by the given key. If no matching properties are found, throws a PropertyNotFoundException

Returns the property identified by the given key. If the property is not found, throws a PropertyNotFoundException

Returns the property identified by the given key. If the property is not found, returns the given defaultValue

Convenience string of getProperty

Convenience string of getProperty

Typed getProperty - returns URL. If property is not a valid url, throws a wrapping ConfigException as a runtime error

Typed getProperty - returns URL. If property is not a valid url, throws a wrapping ConfigException as a runtime error

Returns a list of the keys

Loads the properties from the file at the given URL

Returns information about where the values are being found

Resolves environment variables. Looks for ${xxxx} strings and replace with whatever xxxx is set to in the system environment properties

There are several occasions when an application needs a complete file. For example, a metadata file. This method provides a way of locating that file in different environments. If the filename includes a ${..} then the contents of the brackets are resolved using the system properties. This allows us to make use of Tomcat's locations for example. If the filename is then absolute, the file is resolved normally. If the filename is relative, the file is searched for first in the classpath then in the working directory. If the path is not found, a FileNotFoundException is thrown listing the places looked. If the path is found, a url to it is returned. Hmm not sure if this is really a Configuration thing.... NB this resolves to a URL so it won't find files in jar files

Sets the property to the given list of values

Set property. Stores in cache so it overrides all other properties with the same key.

access a stream to read the contents of the external value from

Returns an input stream containing the content of the external value

Throws

• InaccessibleExternalValueException

access a stream to write the contents of the external value to

Returns an output stream.

Throws

• InaccessibleExternalValueException

create a new indirectParameterValue for the passed in URI

Params

• reference the uri to build an instance for.

Returns a handler for this uri.

Throws

• InaccessibleExternalValueException

access the name of the protocol this object provides support for

Returns name of the protocl this factory can build instances for.

build an external value, direct from a URI String

Params

• location String representation of URI location to build external value for

Returns an external value for this location

Throws

• InaccessibleExternalValueException - if the external value cannot be accessed - e.g. cannot resolve,
• UnrecognizedProtocolException - if the uri protocol / scheme is not recognized

build an external value, direct from a URI

Params

• location location to build external value for

Returns an external value for this location

Throws

• InaccessibleExternalValueException - if the external value cannot be accessed - e.g. cannot resolve,
• UnrecognizedProtocolException - if the uri protocol / scheme is not recognized

build an external value for a particular indirect parameter value

Params

• pval parameter to build external value for

Returns an external value for this parameter.

Throws

• InaccessibleExternalValueException - if the external value cannot be gained - e.g. cannot resolve, no path
• UnrecognizedProtocolException - if the indirection uri format is not recognized.

return true if this library supports the protcol in question

list the protocols supported in this library

Returns specific-to-service - ie fragment

Returns ivo id without the scheme. eg 'ivo://roe.ac.uk/mch/myspace' returns 'roe.ac.uk/mch/myspace'

Returns identifier scheme

Returns true if the given string is likely to be an ivorn - ie if it starts with ivo://

Representation to be used when submitting the IVORN to a registry to be resolved

String representation

Returns the IVORN in URI form

Copy a file

Creates a new user (identified by the given user ivorn) on the storepoint given by the 'target' Ivorn.

Delete a file

Returns a StoreClient delegate for the given ivorn for direct file manipulation

Returns the StoreFile representation of the file at the given AGSL

Returns the user of this delegate - ie the account it is being used by

Gets a file's contents as a stream

Moves/Renames a file

Create a container

Puts the given byte buffer from offset of length bytes, to the given target

Streaming output - returns a stream that can be used to output to the given location

Copies the contents of the file at the given source url to the given location

Add a child to a container.

Params

• name The container name.

Throws

• TreeClientDuplicateException If the container already exists.
• TreeClientServiceException If the service is unable to handle the request.

Add a file to this container.

Params

• name The file name.

Throws

• TreeClientDuplicateException If the file already exists.
• TreeClientServiceException If the service is unable to handle the request.

Get a list (collection) of the current child nodes. Note, you cannot add a child node by adding a node to the collection.

Returns An unmodifiable collection of Node(s) for the child nodes.

Get an InputStream to read data from the file.

Throws

• TreeClientServiceException If the service is unable to handle the request.

Get the mime type for the file.

Returns The mime type for the file contents, or null if is not set..

Throws

• TreeClientServiceException If the service is unable to handle the request.

Get an OutputStream to send data to the file. Openning a new stream to an existing file will over-write the file contents. The client MUST close the output stream to force the transfer to complete.

Throws

• TreeClientServiceException If the service is unable to handle the request.

Access to the node name.

Returns The node name.

Check if this represents a container.

Returns true if this represents a container.

Check if this represents a file.

Returns true if this represents a file.

Get the root node of the account home space.

Returns An AladinAdapterContainer representing the root of the account myspace.

Throws

• TreeClientSecurityException If the adapter is not logged in.
• TreeClientServiceException If unable to handle the request.

Access to the current security token.

Returns The current security token, or null if not logged in.

Login to the AstroGrid community.

Params

• ivorn The 'ivo://...' identifier for the AstroGrid account.
• password The account password.

Throws

• TreeClientLoginException If the login fails.
• TreeClientServiceException If unable to handle the request.

Logout from the AstroGrid community.

Throws

• TreeClientServiceException If unable to handle the request.

access an element in the workflow document by it's unique id.

access the list of steps in the current workflow

inspect version information for this server

access the object model of the current workflow

create a new tool-parameter object, initialized, but unattached to any tool

create a key for the current position in a workflow

Params

• root document root object
• current object to create activity key for

Returns activity key that points to the current object.

Throws

• IllegalArgumentException - if root or current is null, or current is not within the workflow object tree

Returns true if this ActivityKey is the same as the o argument.

Returns true if this ActivityKey is the same as the o argument.

apply the activity key to a document, to access the object it refers to

Params

• root workflow document

Returns the object in the tree that the activity key pointed to, or null if no object was found

Override hashCode.

Returns the Objects hashcode.

construct a new, initialized tool from the default (first) interface in the application descriptor

construct a new, initialized tool from an interface in this application descriptor

Params

• intf the interface to create a tool instance from

Returns a populated tool object

Throws

• IllegalArgumentException if the interface does not belong to this application description.

from a definition of a parameter, create a new, initialized parameter value.

Params

• defn definition of the parameter

Returns a parameter value with name, type initialized. if defn provides a defaultValue, this is set as content

interfaces contain a bunch of 'ParameterRef' objects, that reference 'BaseParameterDefinitions' that are defined elsewhere, and give the type, user interface description, etc of the paramter. This method will get a definition for a parameter reference

Params

• parameterRef the reference to look up

Returns the associated parameter definition.

Throws

• IllegalArgumentException when asked to find definition for a reference that is not in the application description.

convenience method to get a parameter definition for a parameter value. equivalent to getDefinitionForReference(getReferenceForValue(p,i))

Params

Throws

• IllegalArgumentException

access the xml of the original registry entry that defines this Application

Returns dom of registry entry. may be null; if not, root element will be <VODescription>

find the parameter reference assocuated with a parameter value in a particular interface

verify that a tool object matches what is expected by the application (as defined by this descriptor) at moment, checks against information in the application description. in future, could access web services to resolve ucds, or check url parameters, etc.

array of the interface names for this application

system name of the application

user-friendly name of the appliication

query registry for description of a named application

Params

• applicationName name of the application.

Returns an description of the application

Throws

• WorkflowtInterfaceException if an error occurs - i.e. if the application is not found

list names of known tools

list system names and user-friendly names of applications.

cancel a job - halt the execution of it does nothing at the momenr

Params

• jobURN unique identifier of the job

Throws

• WorkflowInterfaceException

delete a job - remove all record of it from the jes store does nothing at the moment

Params

• jobURN unique identifier of the job to delete

list jobs for a particulat user.

Params

• account identifies the user

Returns array of workflow summaries

Throws

• WorkflowInterfaceException

Retreive an annotated workflow document from the jes store

Params

• jobURN unique job id

Returns workflow document, plus annotations. never null

Throws

• WorkflowInterfaceException if document cannot be retreived.

retreive list of jobs for a particular user

Params

• account identifies a user

Returns array of job summaries

Throws

• WorkflowInterfaceException

submit a workflow to the job controller

Params

• workflow workflow document to submit (contains user credentials to execute under)

Returns new unique identifier for the job. never null

Throws

• WorkflowInterfaceException if job cannot be submitted

create a workflow object

Params

• creds credentials for this workflow - contains account, group and authentication token for the user this workflow is going to run as.
• name name of the new workflow
• description a textual description of the workflow

Returns a new workflow document object, that is schema-valid. never null

get a component to manage jobs - executoions of workflows. never null

get a component to query a registry. never null

get a component to build workflows. never null

get a component to access a store. never null

read workflow from the store

Params

• user account details for the owner of the workflow document
• locationToReadFrom ivorn location to read the workflow from.

Returns workflow document object. will never return null

Throws

• WorkflowInterfaceException if document can't be loaded

save workflow to myspace

Params

• user account details for the owner of the workflow
• locationToSaveTo ivorn location to save the document
• workflow workflow document to save

Throws

• WorkflowInterfaceException

Abort an running application.

Params

• executionId the identifier for the execution instance that is to be aborted.

Returns true if aborted successfully.

Throws

• RemoteException
• CeaFault

execute a previously-initialized application

Params

• executionId the id of the application to start

Returns true if execution was started successfully

Throws

• CEADelegateException

retrieve summary information for an applicatin execution - this structure contains input parameters, results, plus execution status.

Params

• executionId the identifier for the instance to query.

Throws

• CEADelegateException

access the results of an application execution

Params

• executionId the identifier for the execution instance to query

Initialize an application asynchronously. The application may be a command line application, a data query or another web service depending on the type of Common Execution Controller that is being contacted.

Params

• tool This is the specification of the application that will be run.
• jobstepID An identifier that the caller can use to keep track of this particular execution instance.
• jobMonitorURL The endpoint of a JobMonitor service that should be called back when the execution has finished.

Returns An identifier that the CommonExecutionConnector service uses to track this instance of the application execution. This is used as an argument to some of the other methods in this interface.

Throws

• RemoteException
• CeaFault

query execution status of an application

Params

• executionId identifier of application to query

Returns message, containing various metadata, including status code.

Throws

• CEADelegateException

register a listener to the progress of an application. the web interface of the listener will be called to notify it of execution events of this application

Params

• executionId the id of the application to listen to
• listenerEndpoint endpoint of the web service (must implement the {@link org.astrogrid.jes.delegate.v1.JobMonitor} interface

Throws

• CEADelegateException

register a listener / consumer for the results of this application execution.

Params

• executionId the id of the application to consume results from.
• listenerEndpoint endpoint of the web service that will consume results (must implement the {@link org.astrogrid.jes.service.v1.cearesults.ResultsLIstener} interface)

Throws

• CEADelegateException

return the registry entry for this common execution controller.

Throws

• RemoteException