com.intel.gpe.clients.api
Interface TargetSystemClient

All Superinterfaces:

ServiceClient, WSLTClient, WSRFClient, WSRPClient

All Known Subinterfaces:

WorkspaceClient

public interface TargetSystemClient
extends WSLTClient

The client interface to the target system resource.

Version:

$Id: TargetSystemClient.java,v 1.10 2006/06/22 13:46:06 lukichev Exp $

Author:

Alexander Lukichev, Ralf Ratering

Method Summary

<ApplicationType extends Application> java.util.List<ApplicationType>	getApplications()
<ApplicationType extends Application> java.util.List<ApplicationType>	getApplications(java.lang.String applicationName) Get application resources with a certain name.
ProcessorType	getCPUArtchitecture() Get the CPU architecture information
int	getIndividualCPUCount() Get the individual CPU count (per node)
int	getIndividualPhysicalMemory() Get the individual physical memory (per node)
<JobClientType extends JobClient> java.util.List<JobClientType>	getJobs()
JobType	getJobType(java.lang.String jobDefinition) Construct the job definition type description from the current target system type and job definition type.
java.lang.String	getName()
java.util.List<java.lang.Double>	getNumericInfo(java.lang.String name) Get the value of NumericInfo properties with the specified name.
OperatingSystemRequirementsType	getOperatingSystem() Get the OS type/version information
<StorageClientType extends StorageClient> StorageClientType	getStorage(java.lang.String type)
<StorageClientType extends StorageClient> java.util.List<StorageClientType>	getStorages()
TargetSystemType	getTargetSystemType() Get the type of the target system
java.util.List<java.lang.String>	getTextInfo(java.lang.String name) Get the value of TextInfo properties with the specified name.
<JobDefinitionType extends Job> JobDefinitionType	newJob(JobType type) Return the job definition template of the certain job definition type.
<JobDefinitionType extends Job> JobDefinitionType	newJob(JobType jobType, byte[] jobDefinition) Create a job definition from the provided byte array
<JobClientType extends JobClient> JobClientType	submit(Job job, java.util.Calendar initialTerminationTime) Submit the job.
boolean	supportsApplication(java.lang.String applicationName, java.lang.String applicationVersion) Check if the application is available on the target system

Methods inherited from interface com.intel.gpe.clients.api.WSLTClient

destroy, getCurrentTime, getTerminationTime, setTerminationTime

Methods inherited from interface com.intel.gpe.clients.api.WSRPClient

getMultipleResourceProperties, getResourceProperty, getResourcePropertyDocument, queryXPath10Properties

Method Detail

submit

<JobClientType extends JobClient> JobClientType submit(Job job,
                                                       java.util.Calendar initialTerminationTime)
                                       throws GPEWrongJobTypeException,
                                              GPEJobNotSubmittedException,
                                              GPEResourceUnknownException,
                                              GPEMiddlewareRemoteException,
                                              GPEMiddlewareServiceException,
                                              GPESecurityException

Submit the job.

Parameters:

job - The job definition. This definition must be supported by the target system, otherwise exception is thrown

initialTerminationTime - The initial value for the job's termination time

Returns:

The client to manage the created job resource

Throws:

GPEWrongJobTypeException - If this target system does corresponding type of job

GPEJobNotSubmittedException - If target system refused to accept a submitted job

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getName

java.lang.String getName()
                         throws GPEInvalidResourcePropertyQNameException,
                                GPEResourceUnknownException,
                                GPEUnmarshallingException,
                                GPESecurityException,
                                GPEMiddlewareRemoteException,
                                GPEMiddlewareServiceException

Returns:

The name of the target system

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Name property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getStorages

<StorageClientType extends StorageClient> java.util.List<StorageClientType> getStorages()
                                                                    throws GPEInvalidResourcePropertyQNameException,
                                                                           GPEResourceUnknownException,
                                                                           GPEUnmarshallingException,
                                                                           GPESecurityException,
                                                                           GPEMiddlewareRemoteException,
                                                                           GPEMiddlewareServiceException

Returns:

The array of storages provided by the target system

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Storage property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getStorage

<StorageClientType extends StorageClient> StorageClientType getStorage(java.lang.String type)
                                                   throws GPEInvalidResourcePropertyQNameException,
                                                          GPEResourceUnknownException,
                                                          GPEUnmarshallingException,
                                                          GPESecurityException,
                                                          GPEMiddlewareRemoteException,
                                                          GPEMiddlewareServiceException

Parameters:

type - The type of the storage

Returns:

The storage of the certain type

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Storage property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getJobs

<JobClientType extends JobClient> java.util.List<JobClientType> getJobs()
                                                        throws GPEInvalidResourcePropertyQNameException,
                                                               GPEResourceUnknownException,
                                                               GPEUnmarshallingException,
                                                               GPESecurityException,
                                                               GPEMiddlewareRemoteException,
                                                               GPEMiddlewareServiceException

Returns:

The jobs available through JobReference resource property of the target system

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide JobReference property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getApplications

<ApplicationType extends Application> java.util.List<ApplicationType> getApplications()
                                                                    throws GPEInvalidResourcePropertyQNameException,
                                                                           GPEResourceUnknownException,
                                                                           GPEUnmarshallingException,
                                                                           GPESecurityException,
                                                                           GPEMiddlewareRemoteException,
                                                                           GPEMiddlewareServiceException

Returns:

The list of available applications got from the Application resource property of the target system

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Application property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

getApplications

<ApplicationType extends Application> java.util.List<ApplicationType> getApplications(java.lang.String applicationName)
                                                                    throws GPEInvalidResourcePropertyQNameException,
                                                                           GPEResourceUnknownException,
                                                                           GPEUnmarshallingException,
                                                                           GPESecurityException,
                                                                           GPEMiddlewareRemoteException,
                                                                           GPEMiddlewareServiceException

Get application resources with a certain name.

Returns:

An array, because there may be multiple versions of the same application

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Application property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

supportsApplication

boolean supportsApplication(java.lang.String applicationName,
                            java.lang.String applicationVersion)
                            throws GPEInvalidResourcePropertyQNameException,
                                   GPEResourceUnknownException,
                                   GPEUnmarshallingException,
                                   GPESecurityException,
                                   GPEMiddlewareRemoteException,
                                   GPEMiddlewareServiceException

Check if the application is available on the target system

Parameters:

applicationName - The name of the required application

Returns:

true if the application is supported

Throws:

GPEInvalidResourcePropertyQNameException - If corresponding job resource does not provide Application property

GPEResourceUnknownException - If WSRF-HE fails to find a resource with corresponding identifier

GPEUnmarshallingException - If something bad happens during convertation from XML to resource property object

GPESecurityException - If client fails to setup security

GPEMiddlewareRemoteException - If middleware throws an analogue of RemoreException

GPEMiddlewareServiceException - If middleware throws an analogue of ServiceException

newJob

<JobDefinitionType extends Job> JobDefinitionType newJob(JobType type)
                                     throws GPEWrongJobTypeException

Return the job definition template of the certain job definition type.

Parameters:

type - The required job definition type

Returns:

The job definition template

Throws:

GPEWrongJobTypeException - If this target system does corresponding type of job

newJob

<JobDefinitionType extends Job> JobDefinitionType newJob(JobType jobType,
                                                         byte[] jobDefinition)
                                     throws GPEWrongJobTypeException

Create a job definition from the provided byte array

Parameters:

jobType -

jobDefinition -

Returns:

Throws:

GPEWrongJobTypeException

getJobType

JobType getJobType(java.lang.String jobDefinition)

Construct the job definition type description from the current target system type and job definition type.

Parameters:

jobDefinition - The job definition type

Returns:

The job type structure

getTextInfo

java.util.List<java.lang.String> getTextInfo(java.lang.String name)
                                             throws GPEInvalidQueryExpressionException,
                                                    GPEQueryEvaluationErrorException,
                                                    GPEUnknownQueryExpressionDialectException,
                                                    GPEResourceUnknownException,
                                                    GPEInvalidResourcePropertyQNameException,
                                                    GPESecurityException,
                                                    GPEUnmarshallingException,
                                                    GPEMiddlewareServiceException,
                                                    GPEMiddlewareRemoteException

Get the value of TextInfo properties with the specified name.

Parameters:

name - - the name of TextInfo properties

Returns:

the values of TextInfo properties

Throws:

GPEMiddlewareRemoteException

GPEMiddlewareServiceException

GPEUnmarshallingException

GPESecurityException

GPEInvalidResourcePropertyQNameException

GPEResourceUnknownException

GPEUnknownQueryExpressionDialectException

GPEQueryEvaluationErrorException

GPEInvalidQueryExpressionException

getNumericInfo

java.util.List<java.lang.Double> getNumericInfo(java.lang.String name)
                                                throws GPEInvalidQueryExpressionException,
                                                       GPEQueryEvaluationErrorException,
                                                       GPEUnknownQueryExpressionDialectException,
                                                       GPEResourceUnknownException,
                                                       GPEInvalidResourcePropertyQNameException,
                                                       GPESecurityException,
                                                       GPEUnmarshallingException,
                                                       GPEMiddlewareServiceException,
                                                       GPEMiddlewareRemoteException

Get the value of NumericInfo properties with the specified name.

Parameters:

name -

Returns:

Throws:

GPEInvalidQueryExpressionException

GPEQueryEvaluationErrorException

GPEUnknownQueryExpressionDialectException

GPEResourceUnknownException

GPEInvalidResourcePropertyQNameException

GPESecurityException

GPEUnmarshallingException

GPEMiddlewareServiceException

GPEMiddlewareRemoteException

getTargetSystemType

TargetSystemType getTargetSystemType()

Get the type of the target system

Returns:

getOperatingSystem

OperatingSystemRequirementsType getOperatingSystem()
                                                   throws GPEMiddlewareRemoteException,
                                                          GPEResourceUnknownException,
                                                          GPEInvalidResourcePropertyQNameException

Get the OS type/version information

Returns:

Throws:

GPEMiddlewareRemoteException

GPEResourceUnknownException

GPEInvalidResourcePropertyQNameException

getCPUArtchitecture

ProcessorType getCPUArtchitecture()
                                  throws GPEMiddlewareRemoteException,
                                         GPEResourceUnknownException,
                                         GPEInvalidResourcePropertyQNameException

Get the CPU architecture information

Returns:

Throws:

GPEMiddlewareRemoteException

GPEResourceUnknownException

GPEInvalidResourcePropertyQNameException

getIndividualCPUCount

int getIndividualCPUCount()
                          throws GPEMiddlewareRemoteException,
                                 GPEResourceUnknownException,
                                 GPEInvalidResourcePropertyQNameException

Get the individual CPU count (per node)

Returns:

Throws:

GPEMiddlewareRemoteException

GPEResourceUnknownException

GPEInvalidResourcePropertyQNameException

getIndividualPhysicalMemory

int getIndividualPhysicalMemory()
                                throws GPEMiddlewareRemoteException,
                                       GPEResourceUnknownException,
                                       GPEInvalidResourcePropertyQNameException

Get the individual physical memory (per node)

Returns:

Throws:

GPEMiddlewareRemoteException

GPEResourceUnknownException

GPEInvalidResourcePropertyQNameException