com.hcl.voltmx.middleware.api

Interface ServicesManager

public interface ServicesManager

ServicesManager is an interface that provides custom code access to other helper classes.

Usage in Java service, pre-processor or post-processor -

 ServicesManager servicesManager = request.getServicesManager();
 

Usage in Custom Filters or Custom Servlets -

 ServicesManager servicesManager = ServicesManagerHelper.getServicesManager();
 

Since:

Foundry V8 SP2 (8.2) release

Method Summary

Modifier and Type	Method and Description
ConfigurableParametersHelper	getConfigurableParametersHelper() Gets the helper class to access the Server and Client App parameters that were set by the developer in admin console.
DatabaseTransactionManager	getDatabaseTransactionManager() Gets the database transaction manager object which is used to execute services in a transaction
DeviceRequestData	getDeviceRequestData() Returns the request data which will have information like device id, request id, cache id and reporting params about current service.
EventManager	getEventManager() Gets the event manager object which is used to subscriber and unsubscribe event subscriber.
EventNotifier	getEventNotifier() Gets the events notifier object which is used to notify events and check status of events.
IdentityHandler	getIdentityHandler() Gets the identity handler which provided access to identity user profile and attributes.
VoltmxCustomMetrics	getVoltmxCustomMetrics() FOR INTERNAL USE ONLY.
OperationData	getOperationData() Returns the operation data which will have information like service id, version, operation about current service.
OperationDataBuilder	getOperationDataBuilder() Gets the operation data builder.
ServiceRequestBuilder	getRequestBuilder(OperationData serviceDataObject) Gets the service request builder.
ResultCache	getResultCache() Gets the ResultCache interface.
ServiceMonitor	getServiceMonitor() Gets the ServiceMonitor instance to capture the service monitoring information in custom code.
void	updateOperation(String operation) Updates the operation of the current service.

Method Detail

getOperationData

OperationData getOperationData()
                        throws AppRegistryException

Returns the operation data which will have information like service id, version, operation about current service.

Returns:

The operation data of current service

Throws:

AppRegistryException

See Also:

OperationData

updateOperation

void updateOperation(String operation)

Updates the operation of the current service. Use OperationsEnum to update the operation.

Note: This should be used only for OBJECT SERVICES. Usage in integration services may not work or may result in unexpected behavior.

Parameters:

operation - the target operation to be updated

Since:

Foundry V8 SP3 (8.3)

See Also:

OperationsEnum

getConfigurableParametersHelper

ConfigurableParametersHelper getConfigurableParametersHelper()

Gets the helper class to access the Server and Client App parameters that were set by the developer in admin console.

Returns:

The helper class to access the Server and Client App parameters

See Also:

ConfigurableParametersHelper

getOperationDataBuilder

OperationDataBuilder getOperationDataBuilder()

Gets the operation data builder.

Returns:

Builder to build OperationData.

See Also:

OperationDataBuilder, OperationData

getRequestBuilder

ServiceRequestBuilder getRequestBuilder(OperationData serviceDataObject)

Gets the service request builder.

Returns:

Builder to build ServiceRequest.

See Also:

ServiceRequestBuilder, ServiceRequest

getVoltmxCustomMetrics

VoltmxCustomMetrics getVoltmxCustomMetrics()

FOR INTERNAL USE ONLY.

Gets the VoltmxCustomMetrics interface.

Returns:

VoltmxCustomMetrics to add Custom Metrics through custom code

getDeviceRequestData

DeviceRequestData getDeviceRequestData()

Returns the request data which will have information like device id, request id, cache id and reporting params about current service.

Returns:

The device request data of current service

Since:

Foundry V8 SP4 (8.4)

See Also:

DeviceRequestData

getResultCache

ResultCache getResultCache()

Gets the ResultCache interface.

Returns:

ResultCache to add custom data to cache

Since:

Foundry V8 SP3 (8.3) release

See Also:

ResultCache

getEventNotifier

EventNotifier getEventNotifier()

Gets the events notifier object which is used to notify events and check status of events.

Returns:

Event notifier object.

Since:

Foundry V8 SP4 FP2 (8.4.2) release

See Also:

EventNotifier

getEventManager

EventManager getEventManager()

Gets the event manager object which is used to subscriber and unsubscribe event subscriber.

Returns:

Event manager object.

Since:

Foundry V8 SP4 FP2 (8.4.2) release

See Also:

EventManager, EventSubscriber

getDatabaseTransactionManager

DatabaseTransactionManager getDatabaseTransactionManager()

Gets the database transaction manager object which is used to execute services in a transaction

Returns:

DatabaseTransactionManager object.

Since:

Foundry V9 release

See Also:

com.hcl.voltmx.middleware.api.DatabaseTransactionManager

getIdentityHandler

IdentityHandler getIdentityHandler()

Gets the identity handler which provided access to identity user profile and attributes.

Returns:

IdentityHandler to get identity data

Since:

Foundry V8 SP4 FP2 (8.4.2) release

See Also:

IdentityHandler

getServiceMonitor

ServiceMonitor getServiceMonitor()

Gets the ServiceMonitor instance to capture the service monitoring information in custom code.

Returns:

The ServiceMonitor instance.

Since:

Foundry V8 SP4 FP3 HF5 (8.4.3.5) release