com.sapportals.portal.prt.deployment.descriptor

Interface IDescriptor

public interface IDescriptor

The Deployment Descriptor

This class provides means of parsing the portalapp.xml descriptor. a descriptor is loaded using one of the load methods. the descriptor is parsed to an IApplication that can be retrieved by using the getApplication method

static tags names and attribute names are provided as well i.e TAG_APPLICATION

Field Summary

static String	ATTR_APPLICATIONALIAS
static String	ATTR_COMPONENTNAME
static String	ATTR_COMPONENTNAME_DEFAULTVALUE
static String	ATTR_ENTRYAPPNAME
static String	ATTR_ENTRYNAME
static String	ATTR_ENTRYPATH
static String	ATTR_ENTRYREBIND
static String	ATTR_ENTRYTYPE
static String	ATTR_PROPERTY_NAME
static String	ATTR_PROPERTY_VALUE
static String	ATTR_SERVICEALIAS
static String	ATTR_SERVIVEDEFAULTNAME
static String	ATTR_SERVIVENAME
static String	DTD_FILENAME
static int	EP50_PARFILE
static int	EP50_ZARFILE
static int	EP60_ARCHIVE
static String	PROPERTY_CLASSNAME
static String	PROPERTY_COMPONENT_TYPE
static String	PROPERTY_PRIVATE_SHARING_REFERENCE
static String	PROPERTY_SERVICE_CLASS_NAME
static String	PROPERTY_SERVICES_REFERENCE
static String	PROPERTY_SHARING_REFERENCE
static String	PROPERTY_STARTUP
static String	TAG_APPLICATION
static String	TAG_APPLICATIONCONFIG
static String	TAG_COMPONENT
static String	TAG_COMPONENTCONFIG
static String	TAG_COMPONENTPROFILE
static String	TAG_COMPONENTS
static String	TAG_ENTRY
static String	TAG_PROPERTY
static String	TAG_REGISTRY
static String	TAG_SERVICE
static String	TAG_SERVICECONFIG
static String	TAG_SERVICEPROFILE
static String	TAG_SERVICES
static String	WARNING_GENERATED_CONTENT

Method Summary

IApplication	getApplication()
Set	getDeclaredResourceBundles()
int	getOriginalFormat() Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.
Document	load(File file) Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.
void	load(File file, String applicationName) load the specified file
Document	load(InputStream is) Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.
void	load(InputStream is, String applicationName)
void	saveAs(OutputStream os) Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.

Field Detail

TAG_APPLICATION

static final String TAG_APPLICATION

See Also:

Constant Field Values

TAG_APPLICATIONCONFIG

static final String TAG_APPLICATIONCONFIG

See Also:

Constant Field Values

TAG_COMPONENTS

static final String TAG_COMPONENTS

See Also:

Constant Field Values

TAG_COMPONENT

static final String TAG_COMPONENT

See Also:

Constant Field Values

TAG_COMPONENTCONFIG

static final String TAG_COMPONENTCONFIG

See Also:

Constant Field Values

TAG_COMPONENTPROFILE

static final String TAG_COMPONENTPROFILE

See Also:

Constant Field Values

ATTR_COMPONENTNAME

static final String ATTR_COMPONENTNAME

See Also:

Constant Field Values

ATTR_COMPONENTNAME_DEFAULTVALUE

static final String ATTR_COMPONENTNAME_DEFAULTVALUE

See Also:

Constant Field Values

TAG_SERVICES

static final String TAG_SERVICES

See Also:

Constant Field Values

TAG_SERVICE

static final String TAG_SERVICE

See Also:

Constant Field Values

TAG_SERVICECONFIG

static final String TAG_SERVICECONFIG

See Also:

Constant Field Values

TAG_SERVICEPROFILE

static final String TAG_SERVICEPROFILE

See Also:

Constant Field Values

ATTR_SERVIVENAME

static final String ATTR_SERVIVENAME

See Also:

Constant Field Values

ATTR_SERVICEALIAS

static final String ATTR_SERVICEALIAS

See Also:

Constant Field Values

ATTR_SERVIVEDEFAULTNAME

static final String ATTR_SERVIVEDEFAULTNAME

See Also:

Constant Field Values

TAG_REGISTRY

static final String TAG_REGISTRY

See Also:

Constant Field Values

TAG_ENTRY

static final String TAG_ENTRY

See Also:

Constant Field Values

ATTR_ENTRYPATH

static final String ATTR_ENTRYPATH

See Also:

Constant Field Values

ATTR_ENTRYAPPNAME

static final String ATTR_ENTRYAPPNAME

See Also:

Constant Field Values

ATTR_ENTRYNAME

static final String ATTR_ENTRYNAME

See Also:

Constant Field Values

ATTR_ENTRYTYPE

static final String ATTR_ENTRYTYPE

See Also:

Constant Field Values

ATTR_ENTRYREBIND

static final String ATTR_ENTRYREBIND

See Also:

Constant Field Values

TAG_PROPERTY

static final String TAG_PROPERTY

See Also:

Constant Field Values

ATTR_PROPERTY_NAME

static final String ATTR_PROPERTY_NAME

See Also:

Constant Field Values

ATTR_PROPERTY_VALUE

static final String ATTR_PROPERTY_VALUE

See Also:

Constant Field Values

ATTR_APPLICATIONALIAS

static final String ATTR_APPLICATIONALIAS

See Also:

Constant Field Values

PROPERTY_CLASSNAME

static final String PROPERTY_CLASSNAME

See Also:

Constant Field Values

PROPERTY_COMPONENT_TYPE

static final String PROPERTY_COMPONENT_TYPE

See Also:

Constant Field Values

PROPERTY_SHARING_REFERENCE

static final String PROPERTY_SHARING_REFERENCE

See Also:

Constant Field Values

PROPERTY_PRIVATE_SHARING_REFERENCE

static final String PROPERTY_PRIVATE_SHARING_REFERENCE

See Also:

Constant Field Values

PROPERTY_SERVICE_CLASS_NAME

static final String PROPERTY_SERVICE_CLASS_NAME

See Also:

Constant Field Values

PROPERTY_SERVICES_REFERENCE

static final String PROPERTY_SERVICES_REFERENCE

See Also:

Constant Field Values

PROPERTY_STARTUP

static final String PROPERTY_STARTUP

See Also:

Constant Field Values

DTD_FILENAME

static final String DTD_FILENAME

See Also:

Constant Field Values

WARNING_GENERATED_CONTENT

static final String WARNING_GENERATED_CONTENT

See Also:

Constant Field Values

EP50_PARFILE

static final int EP50_PARFILE

See Also:

Constant Field Values

EP50_ZARFILE

static final int EP50_ZARFILE

See Also:

Constant Field Values

EP60_ARCHIVE

static final int EP60_ARCHIVE

See Also:

Constant Field Values

Method Detail

load

void load(File file,
          String applicationName)
          throws DeploymentException

load the specified file

Parameters:

file - portalapp.xml file

applicationName - application's name

Throws:

DeploymentException

load

void load(InputStream is,
          String applicationName)
          throws DeploymentException

Parameters:

is - portalapp.xml InputStream

applicationName -

Throws:

DeploymentException

getApplication

IApplication getApplication()

Returns:

loaded IApplication

getDeclaredResourceBundles

Set getDeclaredResourceBundles()

load

Document load(File file)
              throws DeploymentException

Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.

Throws:

DeploymentException

load

Document load(InputStream is)
              throws DeploymentException

Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.

Throws:

DeploymentException

saveAs

void saveAs(OutputStream os)

Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.

getOriginalFormat

int getOriginalFormat()

Deprecated. This method exists only for API compatability and will be removed in 2 major versions. Execution of this method will cause an UnsupportedOperationException.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._deploymentapideprecated	default	EP-PIN-PRT