gov.va.vinci.leo

Class Service

java.lang.Object

gov.va.vinci.leo.tools.LeoProperties

gov.va.vinci.leo.Service

public class Service
extends LeoProperties

This object will deploy a UIMA AS server from the list of primitive descriptor files provided by the caller. Any modules that will be executed must be in the classpath of the Service process, remote modules being the exception once those are implemented. Optionally the user can edit the standard properties file to modify the default settings for the UIMA pipeline execution.

Author:

thomasginter

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOGGER Logger for this class.
protected Map<String,Object>	mAppCtx Application execution map used primarily by the client.
protected org.apache.uima.aae.client.UimaAsynchronousEngine	mUAEngine UIMA Asynchronous Engine object used to deploy the server and later to init and run the client side of the service also.
protected String	uiamAsContainerId When a service is deployed, UIMA assigns it a unique container id to be used for undeploying.

Fields inherited from class gov.va.vinci.leo.tools.LeoProperties

BROKERURL_DEFAULT, ENDPOINT_DEFAULT, LOG, mAggregateDescriptorFile, mBrokerURL, mCasPoolSize, mCCTimeout, mDeleteOnExit, mDeploymentDescriptorFile, mDescriptorDirectory, mEndpoint, mFSHeapSize, mInitTimeout, mJamJmxPort, mJamQueryIntervalInSeconds, mJamResetStatisticsAfterQuery, mJamServerBaseUrl, mPropertiesFile, mServiceName, mTimeout, PROPERTIES_DEFAULT

Constructor Summary

Constructors

Constructor and Description
Service() Default constructor loads the application execution variables from the properties file.
Service(Map<String,Object> propertiesMap) Loads the application execution variables from the map.
Service(String propertiesFile) Constructor which first sets a new properties file then calls the default constructor to load the properties.

Method Summary

Modifier and Type	Method and Description
void	deploy() Initialize the mAppCtx and mUAEngine objects then deploy the service.
void	deploy(org.apache.uima.analysis_engine.AnalysisEngineDescription aggregate) Use the AnalysisEngineDescription as input for the deployment descriptor that is generated.
void	deploy(ArrayList<String> primitives, boolean byName) Create a deployment descriptor and initialize the mAppCtx and mUAEngine objects then call deploy to deploy the service.
void	deploy(LeoAEDescriptor faed) Initialize the Deployment Descriptor for the service using the provided LeoAEDescriptor object as the Top Descriptor.
void	deploy(LeoDeployDescriptor fdd) Initialize the service using the provided LeoDeployDescriptor object as the basis of the deployment information gov.va.vinci.leo.model.
void	deploy(LeoTypeSystemDescription leoTypeSystemDescription, int numInstances, LeoAnnotator... annotators) Initialize a pipeline by generating the aggregate descriptor file from the list of LeoAnnotator objects then deploy it in the UIMA-AS framework.
void	deploy(LeoTypeSystemDescription leoTypeSystemDescription, LeoAnnotator... annotators) Initialize a pipeline by generating the aggregate descriptor file from the list of LeoAnnotator objects then deploy it in the UIMA-AS framework.
void	deploy(List<LeoAEDescriptor> primitives) Initialize a service pipeline by first generating an aggregate descriptor from a list of LeoAEDescriptor objects.
void	deploy(List<LeoAnnotator> annotators, int numInstances, LeoTypeSystemDescription leoTypeSystemDescription) Initialize a pipeline by generating the aggregate descriptor file from the list of LeoAnnotator objects then deploy it in the UIMA-AS framework.
String	getAggregateDescriptorFile() Get the aggregate descriptor file path.
protected void	registerWithJam() Call the appropriate JAM web services to register this service with jam.
void	undeploy() Undeploys a running service from the UIMA AS engine.

Methods inherited from class gov.va.vinci.leo.tools.LeoProperties

getBrokerURL, getCasPoolSize, getCCTimeout, getDeploymentDescriptorFile, getDescriptorDirectory, getEndpoint, getFSHeapSize, getInitTimeout, getInputQueueName, getJamJmxPort, getJamQueryIntervalInSeconds, getJamServerBaseUrl, getServiceName, getTimeout, isDeleteOnExit, isJamResetStatisticsAfterQuery, loadDefaults, loadProperties, loadprops, loadprops, setAggregateDescriptorFile, setBrokerURL, setCasPoolSize, setCCTimeout, setDeleteOnExit, setDeploymentDescriptorFile, setDescriptorDirectory, setEndpoint, setFSHeapSize, setInitTimeout, setInputQueueName, setJamJmxPort, setJamQueryIntervalInSeconds, setJamResetStatisticsAfterQuery, setJamServerBaseUrl, setServiceName, setTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public static final org.apache.log4j.Logger LOGGER

Logger for this class.

mAppCtx

protected Map<String,Object> mAppCtx

Application execution map used primarily by the client.

mUAEngine

protected org.apache.uima.aae.client.UimaAsynchronousEngine mUAEngine

UIMA Asynchronous Engine object used to deploy the server and later to init and run the client side of the service also.

uiamAsContainerId

protected String uiamAsContainerId

When a service is deployed, UIMA assigns it a unique container id to be used for undeploying. This is that container id, and will be null until a service is deployed, and reset to null if a service is undeployed.

Constructor Detail

Service

public Service()
        throws Exception

Default constructor loads the application execution variables from the properties file. If variables are not provided then default values are used where they can be.

Throws:

Exception - if properties file cannot be read or if data is invalid

Service

public Service(Map<String,Object> propertiesMap)
        throws FileNotFoundException

Loads the application execution variables from the map.

Parameters:

propertiesMap - the map of properties to set. Map should have the property name as the key, and value as the value. See LeoProperties for which properties can be set.

Throws:

FileNotFoundException - If deploymentDescriptor is specified, but not found or accessible.

Service

public Service(String propertiesFile)
        throws Exception

Constructor which first sets a new properties file then calls the default constructor to load the properties.

Parameters:

propertiesFile - path to a properties file to be used

Throws:

Exception - if there is a problem loading the properties.

Method Detail

getAggregateDescriptorFile

public String getAggregateDescriptorFile()

Get the aggregate descriptor file path.

Overrides:

getAggregateDescriptorFile in class LeoProperties

Returns:

the mAggregateDescriptorFile

deploy

public void deploy(ArrayList<String> primitives,
                   boolean byName)
            throws Exception

Create a deployment descriptor and initialize the mAppCtx and mUAEngine objects then call deploy to deploy the service.

Parameters:

primitives - ArrayList of primitive Analysis Engine descriptors

byName - if true, it is assumed the list of primitives exists in the classpath. If false, full paths to the primitives is required.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(List<LeoAEDescriptor> primitives)
            throws Exception

Initialize a service pipeline by first generating an aggregate descriptor from a list of LeoAEDescriptor objects.

Parameters:

primitives - a list of primitive components to deploy as a service.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(LeoTypeSystemDescription leoTypeSystemDescription,
                   LeoAnnotator... annotators)
            throws Exception

Initialize a pipeline by generating the aggregate descriptor file from the list of LeoAnnotator objects then deploy it in the UIMA-AS framework.

Parameters:

leoTypeSystemDescription - the type system to add to each delegate.

annotators - one or more annotators to deploy as a pipeline in the service.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(LeoTypeSystemDescription leoTypeSystemDescription,
                   int numInstances,
                   LeoAnnotator... annotators)
            throws Exception

Initialize a pipeline by generating the aggregate descriptor file from the list of LeoAnnotator objects then deploy it in the UIMA-AS framework.

Parameters:

leoTypeSystemDescription - the type system to add to each delegate.

numInstances - number of pipeline instances to deploy.

annotators - one or more annotators to deploy as a pipeline in the service.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(List<LeoAnnotator> annotators,
                   int numInstances,
                   LeoTypeSystemDescription leoTypeSystemDescription)
            throws Exception

Initialize a pipeline by generating the aggregate descriptor file from the list of LeoAnnotator objects then deploy it in the UIMA-AS framework.

Parameters:

annotators - list of annotators to deploy as a pipeline in the service.

numInstances - number of pipeline instances to deploy.

leoTypeSystemDescription - the type system to add to each delegate.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(org.apache.uima.analysis_engine.AnalysisEngineDescription aggregate)
            throws Exception

Use the AnalysisEngineDescription as input for the deployment descriptor that is generated.

Parameters:

aggregate - Aggregate AnalysisEngineDescriptor to be used in the UIMA AS service

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(LeoAEDescriptor faed)
            throws Exception

Initialize the Deployment Descriptor for the service using the provided LeoAEDescriptor object as the Top Descriptor.

Parameters:

faed - the descriptor to be used for this service.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy(LeoDeployDescriptor fdd)
            throws Exception

Initialize the service using the provided LeoDeployDescriptor object as the basis of the deployment information gov.va.vinci.leo.model.

Parameters:

fdd - the descriptor to be used for this service.

Throws:

Exception - if any error occurs during deployment.

deploy

public void deploy()
            throws Exception

Initialize the mAppCtx and mUAEngine objects then deploy the service. Requires that a deployment descriptor file has already been set.

Throws:

Exception - if any error occurs during deployment.

undeploy

public void undeploy()
              throws Exception

Undeploys a running service from the UIMA AS engine. If no service is currently running, no error is thrown, the method simply returns.

Throws:

Exception

registerWithJam

protected void registerWithJam()

Call the appropriate JAM web services to register this service with jam.