gov.va.vinci.leo.descriptors

Class LeoDeployDescriptor

java.lang.Object

gov.va.vinci.leo.descriptors.LeoDeployDescriptor

public class LeoDeployDescriptor
extends Object

Store the metadata for a Deployment Descriptor. Allow parameters to be modified as well as support serializing the descriptor to XML.

Author:

thomasginter

Constructor Summary

Constructors

Constructor and Description
LeoDeployDescriptor(LeoAEDescriptor faed) Constructor that sets top descriptor initially.
LeoDeployDescriptor(String filename, boolean byName) Constructor to start with top descriptor by at filename.

Method Summary

Modifier and Type	Method and Description
protected void	deploymentSectionXML(TransformerHandler thd) Serialize the deployment section.
String	getBrokerURL() get the broker url for this deployment descriptor.
int	getCasPoolSize() Get the cas pool size for this deployment.
String	getDescription() Get the description of this deployment descriptor.
String	getEndpoint() Get the endpoint for this deployment descriptor.
int	getInitialFsHeapSize() get the initial fs heap size for this deployment.
String	getName() Return the name of this Deployment.
LeoAEDescriptor	getTopDescriptor() Get a reference to the top descriptor for this service.
protected void	serviceSectionXML(TransformerHandler thd) Serialize the service section.
LeoDeployDescriptor	setBrokerURL(String brokerURL) Set the broker url for this deployment descriptor.
LeoDeployDescriptor	setCasPoolSize(int casPoolSize) Set the cas pool size for this deployment.
LeoDeployDescriptor	setDescription(String description) Set the description for this deployment descriptor.
LeoDeployDescriptor	setEndpoint(String endpoint) Set the endpoint for this deployment descriptor.
LeoDeployDescriptor	setInitialFsHeapSize(int initialFsHeapSize) set the initial fs heap size for this deployment.
LeoDeployDescriptor	setName(String name) Set the name of the Deployment.
LeoDeployDescriptor	setTopDescriptor(LeoAEDescriptor faed) Set the top descriptor for this deployment to the LeoAEDescriptor object provided.
LeoDeployDescriptor	setTopDescriptor(String filename, boolean byName) Set the top descriptor for this deployment by importing the descriptor by name or value.
void	toXML(OutputStream os) Serialize the deployment descriptor to xml using the output stream provided.
void	toXML(String filename) Serialize this Deployment Descriptor to a file at the name and path provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

LeoDeployDescriptor

public LeoDeployDescriptor(String filename,
                           boolean byName)
                    throws IOException,
                           org.apache.uima.util.InvalidXMLException

Constructor to start with top descriptor by at filename.

Parameters:

filename - path to import AnalysisEngineDescriptor by name or location

byName - if true import filename by name in classpath if false import filename by location

Throws:

IOException - if the descriptor cannot created.

org.apache.uima.util.InvalidXMLException - if there is a problem creating the xml.

LeoDeployDescriptor

public LeoDeployDescriptor(LeoAEDescriptor faed)

Constructor that sets top descriptor initially.

Parameters:

faed - set the Top Descriptor to the LeoAEDescriptor provided

Method Detail

setName

public LeoDeployDescriptor setName(String name)

Set the name of the Deployment.

Parameters:

name - the name of the deployment

getName

public String getName()

Return the name of this Deployment.

Returns:

the name of this deployment

setDescription

public LeoDeployDescriptor setDescription(String description)

Set the description for this deployment descriptor.

Parameters:

description - the description of this deployment

getDescription

public String getDescription()

Get the description of this deployment descriptor.

Returns:

the description

getCasPoolSize

public int getCasPoolSize()

Get the cas pool size for this deployment.

Returns:

the size of the CAS pool

setCasPoolSize

public LeoDeployDescriptor setCasPoolSize(int casPoolSize)

Set the cas pool size for this deployment.

Parameters:

casPoolSize - the size of the CAS pool to set

getInitialFsHeapSize

public int getInitialFsHeapSize()

get the initial fs heap size for this deployment.

Returns:

the initialFsHeapSize

setInitialFsHeapSize

public LeoDeployDescriptor setInitialFsHeapSize(int initialFsHeapSize)

set the initial fs heap size for this deployment.

Parameters:

initialFsHeapSize - the initialFsHeapSize to set

getBrokerURL

public String getBrokerURL()

get the broker url for this deployment descriptor.

Returns:

the BrokerURL for the queue services

setBrokerURL

public LeoDeployDescriptor setBrokerURL(String brokerURL)

Set the broker url for this deployment descriptor.

Parameters:

brokerURL - the BrokerURL for the queue services to set

getEndpoint

public String getEndpoint()

Get the endpoint for this deployment descriptor.

Returns:

the mEndpoint

setEndpoint

public LeoDeployDescriptor setEndpoint(String endpoint)

Set the endpoint for this deployment descriptor.

Parameters:

endpoint - the Endpoint queue name to set

getTopDescriptor

public LeoAEDescriptor getTopDescriptor()

Get a reference to the top descriptor for this service.

Returns:

LeoAEDescriptor object representing the top descriptor

setTopDescriptor

public LeoDeployDescriptor setTopDescriptor(String filename,
                                            boolean byName)
                                     throws IOException,
                                            org.apache.uima.util.InvalidXMLException

Set the top descriptor for this deployment by importing the descriptor by name or value.

Parameters:

filename - descriptor to import by name or location

byName - if true import filename by name in classpath if false import filename by location

Throws:

IOException - if the descriptor cannot created.

org.apache.uima.util.InvalidXMLException - if there is a problem creating the xml.

setTopDescriptor

public LeoDeployDescriptor setTopDescriptor(LeoAEDescriptor faed)

Set the top descriptor for this deployment to the LeoAEDescriptor object provided.

Parameters:

faed - the LeoAEDescriptor object to set as the top Descriptor

toXML

public void toXML(String filename)
           throws Exception

Serialize this Deployment Descriptor to a file at the name and path provided.

Parameters:

filename - File name and path where the xml file will be serialized

Throws:

Exception - if the file cannot be accessed or the xml not written.

toXML

public void toXML(OutputStream os)
           throws Exception

Serialize the deployment descriptor to xml using the output stream provided.

Parameters:

os - Output stream used for serializing the xml file

Throws:

Exception - if the file cannot be accessed or the xml not written.

deploymentSectionXML

protected void deploymentSectionXML(TransformerHandler thd)
                             throws Exception

Serialize the deployment section.

Parameters:

thd - TransformerHandler that writes the xml out

Throws:

Exception - if there is no descriptor to output

serviceSectionXML

protected void serviceSectionXML(TransformerHandler thd)
                          throws Exception

Serialize the service section.

Parameters:

thd - TransformerHandler that writes the xml out

Throws:

Exception - if there is no descriptor to output