org.youscope.serverinterfaces

Interface ComponentProvider

All Superinterfaces:

java.rmi.Remote

public interface ComponentProvider
extends java.rmi.Remote

Interface to create measurement components like jobs or resources.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
Component	createComponent(PositionInformation positionInformation, Configuration configuration) Creates a measurement component for the given configuration.
<T extends Component> T	createComponent(PositionInformation positionInformation, Configuration configuration, java.lang.Class<T> componentKind) Creates a measurement component of a given type for the given configuration.
Component	createComponent(PositionInformation positionInformation, java.lang.String typeIdentifier) Creates a component with the given type identifier and its default configuration Note that not all components support default construction.
<T extends Component> T	createComponent(PositionInformation positionInformation, java.lang.String typeIdentifier, java.lang.Class<T> componentInterface) Creates a component with the given type identifier and its default configuration, which additionally has a given interface.
Job	createJob(PositionInformation positionInformation, JobConfiguration jobConfiguration) Creates a job for the given configuration.
<T extends Job> T	createJob(PositionInformation positionInformation, JobConfiguration jobConfiguration, java.lang.Class<T> jobInterface) Creates a job of a given class for the given configuration.
Job	createJob(PositionInformation positionInformation, java.lang.String typeIdentifier) Creates a job which has a given type identifier with its default configuration.
<T extends Job> T	createJob(PositionInformation positionInformation, java.lang.String typeIdentifier, java.lang.Class<T> jobInterface) Creates a job which has a given type identifier and interface with its default configuration.

Method Detail

createComponent

Component createComponent(PositionInformation positionInformation,
                          Configuration configuration)
                   throws ComponentCreationException,
                          ConfigurationException,
                          java.rmi.RemoteException

Creates a measurement component for the given configuration.

Parameters:

configuration - The configuration of the component.

positionInformation - The abstract position of the newly created component in the measurement.

Returns:

A newly created component for the given configuration.

Throws:

ComponentCreationException

ConfigurationException

java.rmi.RemoteException

createComponent

<T extends Component> T createComponent(PositionInformation positionInformation,
                                        java.lang.String typeIdentifier,
                                        java.lang.Class<T> componentInterface)
                                 throws ComponentCreationException,
                                        java.rmi.RemoteException

Creates a component with the given type identifier and its default configuration, which additionally has a given interface. Note that not all components support default construction. In this case, a ComponentCreationException is thrown. Furthermore, note that the state of the component might be invalid, and that the component should be further configured using the component's interface methods.

Parameters:

positionInformation - The abstract position of the newly created component in the measurement.

typeIdentifier - The type identifier of the component.

componentInterface - The interface of the component which should be created.

Returns:

A newly created component with the given type identifier and interface.

Throws:

ComponentCreationException

java.rmi.RemoteException

createComponent

Component createComponent(PositionInformation positionInformation,
                          java.lang.String typeIdentifier)
                   throws ComponentCreationException,
                          java.rmi.RemoteException

Creates a component with the given type identifier and its default configuration Note that not all components support default construction. In this case, a ComponentCreationException is thrown. Furthermore, note that the state of the component might be invalid, and that the component should be further configured using the component's interface methods.

Parameters:

positionInformation - The abstract position of the newly created component in the measurement.

typeIdentifier - The type identifier of the component.

Returns:

A newly created component with the given type identifier and interface.

Throws:

ComponentCreationException

java.rmi.RemoteException

createComponent

<T extends Component> T createComponent(PositionInformation positionInformation,
                                        Configuration configuration,
                                        java.lang.Class<T> componentKind)
                                 throws ComponentCreationException,
                                        ConfigurationException,
                                        java.rmi.RemoteException

Creates a measurement component of a given type for the given configuration. If the component corresponding to the configuration is not of the specified type, a ComponentCreationException is thrown.

Parameters:

componentKind - The super-class/kind of the component.

configuration - The configuration of the component.

positionInformation - The abstract position of the newly created component in the measurement.

Returns:

A newly created component for the given configuration.

Throws:

ComponentCreationException

ConfigurationException

java.rmi.RemoteException

createJob

Job createJob(PositionInformation positionInformation,
              JobConfiguration jobConfiguration)
       throws ComponentCreationException,
              ConfigurationException,
              java.rmi.RemoteException

Creates a job for the given configuration. Shorthand for createComponent(positionInformation, jobConfiguration, Job.class. If the component corresponding to the configuration is not a job, a ComponentCreationException is thrown.

Parameters:

jobConfiguration - The configuration of the job.

positionInformation - The abstract position of the newly created job in the measurement.

Returns:

A newly created job for the given job configuration.

Throws:

ComponentCreationException

ConfigurationException

java.rmi.RemoteException

createJob

<T extends Job> T createJob(PositionInformation positionInformation,
                            java.lang.String typeIdentifier,
                            java.lang.Class<T> jobInterface)
                     throws ComponentCreationException,
                            java.rmi.RemoteException

Creates a job which has a given type identifier and interface with its default configuration. Note that not all jobs support default construction. In this case, a ComponentCreationException is thrown. Furthermore, note that the state of the job might be invalid, and that the job should be further configured using the job interface methods.

Parameters:

positionInformation - The abstract position of the newly created job in the measurement.

typeIdentifier - Type identifier of job.

jobInterface - The interface of the job which should be created.

Returns:

A newly created job with the given interface.

Throws:

ComponentCreationException

java.rmi.RemoteException

createJob

Job createJob(PositionInformation positionInformation,
              java.lang.String typeIdentifier)
       throws ComponentCreationException,
              java.rmi.RemoteException

Creates a job which has a given type identifier with its default configuration. Note that not all jobs support default construction. In this case, a ComponentCreationException is thrown. Furthermore, note that the state of the job might be invalid, and that the job should be further configured using the job interface methods.

Parameters:

positionInformation - The abstract position of the newly created job in the measurement.

typeIdentifier - Type identifier of job.

Returns:

A newly created job with the given interface.

Throws:

ComponentCreationException

java.rmi.RemoteException

createJob

<T extends Job> T createJob(PositionInformation positionInformation,
                            JobConfiguration jobConfiguration,
                            java.lang.Class<T> jobInterface)
                     throws ComponentCreationException,
                            ConfigurationException,
                            java.rmi.RemoteException

Creates a job of a given class for the given configuration. Shorthand for createComponent(positionInformation, jobConfiguration, jobInterface). If the component corresponding to the configuration does not implement the given job interface, a ComponentCreationException is thrown.

Parameters:

jobConfiguration - The configuration of the job.

positionInformation - The abstract position of the newly created job in the measurement.

jobInterface - The interface of the job which should be created.

Returns:

A newly created job with the given interface for the given job configuration.

Throws:

ComponentCreationException

ConfigurationException

java.rmi.RemoteException