com.sapportals.portal.prt.deployment.descriptor

Interface IApplication

public interface IApplication

The Deployment Descriptor

Field Summary

static String	AUTHENTICATIONPOLICY_50
static String	CLASSLOADINGPOLICY_COREACCESSINAPI
static String	CLASSLOADINGPOLICY_NONTRANSITIVE
static String	CLASSLOADINGPOLICY_TESTINGCOREACCESS
static String	CONFIG_KEY_DELEGATE specifies the delegee
static String	CONFIG_KEY_MODE specifies mode delegation
static String	DEFAULT_SECURITY_ZONE_VALUE
static String	DEPLOYMENTPOLICY_50
static String	PROFILE_KEY_AUTHENTICATIONPOLICY specifies the authentication policy used for the application.
static String	PROFILE_KEY_CLASSLOADINGPOLICY specifies the class loading policy used for the application.
static String	PROFILE_KEY_DEPLOYMENTPOLICY specifies the deployment policy used for the application.
static String	PROFILE_KEY_LOADONSTARTUP
static String	PROFILE_KEY_PRIVATESHARINGREF specifies (additional) application sharing references for the private code of an application.
static String	PROFILE_KEY_RELEASABLE
static String	PROFILE_KEY_SECURITY_ZONE default security zone for ep50 archives
static String	PROFILE_KEY_SERVICESREF
static String	PROFILE_KEY_SHARINGACCESS
static String	PROFILE_KEY_SHARINGREF specifies application sharing references for the public code of an application.
static String	PROFILE_KEY_SYSTEM
static String	PROFILE_SHARING_SHARED
static String	PROFILE_SHARING_SYSTEM

Method Summary

String	getAlias()
List	getAliases()
IComponent	getComponent(String componentName)
String	getComponentClassName(String componentName)
List	getComponentNames()
IComponentList	getComponents()
String	getComponentType(String componentName)
IConfiguration	getConfiguration()
IConfiguration	getConfiguration(String componentName)
IEntryList	getEntries() returns application registry as an IEntryMap object or null when no registry exists
String	getName()
List	getPrivateSharingRefs()
IConfiguration	getProfile(String componentName)
List	getPublicSharingRefs()
IService	getService(String ServiceName)
List	getServiceAliases()
String	getServiceClassName(String serviceName)
IConfiguration	getServiceConfiguration(String serviceName)
IConfiguration	getServiceProfile(String serviceName)
IServiceList	getServices()
List	getServicesRefs()
List	getStartupServiceNames()
boolean	hasSystemReference()
boolean	isLoadOnStartup()

Field Detail

CONFIG_KEY_MODE

static final String CONFIG_KEY_MODE

specifies mode delegation

See Also:

Constant Field Values

CONFIG_KEY_DELEGATE

static final String CONFIG_KEY_DELEGATE

specifies the delegee

See Also:

Constant Field Values

PROFILE_KEY_SHARINGREF

static final String PROFILE_KEY_SHARINGREF

specifies application sharing references for the public code of an application. These also apply to the private code parts of the application.

See Also:

Constant Field Values

PROFILE_KEY_PRIVATESHARINGREF

static final String PROFILE_KEY_PRIVATESHARINGREF

specifies (additional) application sharing references for the private code of an application.

See Also:

Constant Field Values

PROFILE_KEY_CLASSLOADINGPOLICY

static final String PROFILE_KEY_CLASSLOADINGPOLICY

specifies the class loading policy used for the application. It's a comma separated list. Current values are

• 5.0 - means non-transitive delegation
• CoreAccessInAPI - means that the private (core) section is (exclusively) visible in the public (API) part.
• CoreAccessForTesting - means that the private core section of referenced apps is visible from this app's core loader.

See Also:

Constant Field Values

CLASSLOADINGPOLICY_NONTRANSITIVE

static final String CLASSLOADINGPOLICY_NONTRANSITIVE

See Also:

Constant Field Values

CLASSLOADINGPOLICY_COREACCESSINAPI

static final String CLASSLOADINGPOLICY_COREACCESSINAPI

See Also:

Constant Field Values

CLASSLOADINGPOLICY_TESTINGCOREACCESS

static final String CLASSLOADINGPOLICY_TESTINGCOREACCESS

See Also:

Constant Field Values

PROFILE_KEY_SECURITY_ZONE

static final String PROFILE_KEY_SECURITY_ZONE

default security zone for ep50 archives

See Also:

Constant Field Values

DEFAULT_SECURITY_ZONE_VALUE

static final String DEFAULT_SECURITY_ZONE_VALUE

See Also:

Constant Field Values

PROFILE_KEY_DEPLOYMENTPOLICY

static final String PROFILE_KEY_DEPLOYMENTPOLICY

specifies the deployment policy used for the application. Current values are

• 5.0 - means that the deployment of a new version does not replace the old one but try to patch it, taking care of the PreservedConfigPaths property

See Also:

Constant Field Values

DEPLOYMENTPOLICY_50

static final String DEPLOYMENTPOLICY_50

See Also:

Constant Field Values

PROFILE_KEY_AUTHENTICATIONPOLICY

static final String PROFILE_KEY_AUTHENTICATIONPOLICY

specifies the authentication policy used for the application. Current values are

• 5.0 - means that the authentication must rely on the AuthRequirement property

See Also:

Constant Field Values

AUTHENTICATIONPOLICY_50

static final String AUTHENTICATIONPOLICY_50

See Also:

Constant Field Values

PROFILE_KEY_SERVICESREF

static final String PROFILE_KEY_SERVICESREF

See Also:

Constant Field Values

PROFILE_SHARING_SYSTEM

static final String PROFILE_SHARING_SYSTEM

See Also:

Constant Field Values

PROFILE_KEY_SHARINGACCESS

static final String PROFILE_KEY_SHARINGACCESS

See Also:

Constant Field Values

PROFILE_SHARING_SHARED

static final String PROFILE_SHARING_SHARED

See Also:

Constant Field Values

PROFILE_KEY_RELEASABLE

static final String PROFILE_KEY_RELEASABLE

See Also:

Constant Field Values

PROFILE_KEY_SYSTEM

static final String PROFILE_KEY_SYSTEM

See Also:

Constant Field Values

PROFILE_KEY_LOADONSTARTUP

static final String PROFILE_KEY_LOADONSTARTUP

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns:

Name of IApplication

getAlias

String getAlias()

Returns:

Alias of IApplication or null if no alias exists

getEntries

IEntryList getEntries()

returns application registry as an IEntryMap object or null when no registry exists

getConfiguration

IConfiguration getConfiguration()

Returns:

application-config as an IConfiguration object or null if no application-config exists

getComponents

IComponentList getComponents()

Returns:

application's components as an IComponentMap object or null if no components exist

getServices

IServiceList getServices()

Returns:

application's services as an IServiceMap object or null if no services exist

getComponent

IComponent getComponent(String componentName)

Parameters:

componentName - name of requested component

Returns:

IComponent named componentName or null if no such component exits

getService

IService getService(String ServiceName)

Parameters:

ServiceName - name of requestedservice

Returns:

IService named serviceName or null if no such service exits

getAliases

List getAliases()

Returns:

application aliases

getServiceAliases

List getServiceAliases()

Returns:

services aliases

getComponentClassName

String getComponentClassName(String componentName)

getComponentNames

List getComponentNames()

Returns:

List

getComponentType

String getComponentType(String componentName)

getConfiguration

IConfiguration getConfiguration(String componentName)

Parameters:

componentName - - component name

Returns:

IConfiguration

getPublicSharingRefs

List getPublicSharingRefs()

Returns:

List

getPrivateSharingRefs

List getPrivateSharingRefs()

Returns:

List

getProfile

IConfiguration getProfile(String componentName)

Parameters:

componentName - - component name

Returns:

IConfiguration

getServiceClassName

String getServiceClassName(String serviceName)

Parameters:

serviceName -

Returns:

String

getServiceConfiguration

IConfiguration getServiceConfiguration(String serviceName)

Parameters:

serviceName - - service name

Returns:

IConfiguration

getServiceProfile

IConfiguration getServiceProfile(String serviceName)

Parameters:

serviceName - - service name

Returns:

IConfiguration

getServicesRefs

List getServicesRefs()

Returns:

List

getStartupServiceNames

List getStartupServiceNames()

Returns:

List

hasSystemReference

boolean hasSystemReference()

isLoadOnStartup

boolean isLoadOnStartup()

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] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._deploymentapideprecated	default	EP-PIN-PRT