com.hyfinity.xplatform

Interface XPlatform

All Known Implementing Classes:

XPlatformFull, XPlatformLite

public interface XPlatform

XPlatform Interface represents the main entry point into the platform. An instance should be created via XPlatformFactory. We have two implementations - XPlatformFull which provides the complete scalable XML platform - XPlatformLite which delegates to custom Java code.

Version:

1.0

Author:

Hyfinity Ltd. Copyright (C) 2017

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WEBMAKER_CLOUD_ENV_PROPERTY The name of the system property that should be set to indicate we are running in the more restrictive cloud environment.
static java.lang.String	WEBMAKER_STUDIO_TEST_ENV_PROPERTY The name of the system property that should be set to indicate we are running in the more restrictive cloud environment.

Method Summary

Modifier and Type	Method and Description
CacheManager	getCacheManager() CacheManager accessor method.
MorphycConfig	getMorphycConfig() Returns the MorphycConfig object used by this xplatform instance.
java.lang.String	getReport() Returns full reporting information on the current state of this xplatform.
XLog	getXLog() XLog accessor method.
void	refreshLogSettings() Reloads the morphyc file and refreshes the log settings based on the details now contained in it.
boolean	service(java.lang.String service, XDocument request, XDocument response, java.lang.String action, RequestIdentification requestID) Service the given request using the appropriate agent for the given service name.
void	shutdown() Shuts down this xplatform, and frees all resources used.
void	shutdown(boolean forRestart) Shuts down this xplatform, and frees all resources used.
void	startup() This method initialises the xplatform, and must be called before any service request are made.

Field Detail

WEBMAKER_STUDIO_TEST_ENV_PROPERTY

static final java.lang.String WEBMAKER_STUDIO_TEST_ENV_PROPERTY

The name of the system property that should be set to indicate we are running in the more restrictive cloud environment.

See Also:

Constant Field Values

WEBMAKER_CLOUD_ENV_PROPERTY

static final java.lang.String WEBMAKER_CLOUD_ENV_PROPERTY

The name of the system property that should be set to indicate we are running in the more restrictive cloud environment.

See Also:

Constant Field Values

Method Detail

startup

void startup()

This method initialises the xplatform, and must be called before any service request are made. This includes parsing the morphyc file, initialising logging, and depending on the execution mode, may also initialise all agents and assets.

shutdown

void shutdown()

Shuts down this xplatform, and frees all resources used.

shutdown

void shutdown(boolean forRestart)

Shuts down this xplatform, and frees all resources used.

Parameters:

forRestart - boolean indicating whether the platform is being shutdown in preparation to be restarted. If this is true, then some shutdown steps (such as deregistering JDBC drivers) are not completed.

refreshLogSettings

void refreshLogSettings()

Reloads the morphyc file and refreshes the log settings based on the details now contained in it.

getXLog

XLog getXLog()

XLog accessor method.

Returns:

the XLog object for this platform that should be used for all logging requests.

getMorphycConfig

MorphycConfig getMorphycConfig()

Returns the MorphycConfig object used by this xplatform instance.

Returns:

the MorphycConfig object.

getCacheManager

CacheManager getCacheManager()

CacheManager accessor method. May return null.

Returns:

the CacheManager object for this platform that should be used to add or retrieve any cached data.

service

boolean service(java.lang.String service,
                XDocument request,
                XDocument response,
                java.lang.String action,
                RequestIdentification requestID)

Service the given request using the appropriate agent for the given service name. This is the standard form that takes an XDocument and returns an XDocument.

Parameters:

service - A string containing the full service name to call

requestID - A RequestIdentification object containing the ID details for this request.

request - The XDocument detailing the request message.

response - The XDocument that will contain the response.

action - The action that should be called.

Returns:

A boolean indicating the success or otherwise of the service call.

getReport

java.lang.String getReport()

Returns full reporting information on the current state of this xplatform. This method just collates information returned from the resource manager objects this xplatform contains.

Returns:

An XML String containing the state information.

See Also:

MorphycConfig.getReport(), XAgentRM.getReport()