Package org.onehippo.cms7.crisp.hst.module

Class CrispHstServices

java.lang.Object

org.onehippo.cms7.crisp.hst.module.CrispHstServices

public class CrispHstServices
extends Object

Convenient utility to allow easy access to the singleton ResourceServiceBroker in an application.

Note: Each set of the static members of org.hippoecm.hst.site.HstServices in multiple wars has its own ComponentManager. So, the ComponentManager of each application can be used to try to find the local CRISP ResourceServiceBroker component. If not found from the local ComponentManager, then it can try to find it from HippoServiceRegistry as fallback.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODULE_NAME	CRISP HST Addon Module name.

Method Summary

Modifier and Type	Method	Description
static ResourceServiceBroker	getDefaultResourceServiceBroker()	Deprecated. Use getDefaultResourceServiceBroker(ComponentManager) instead.
static ResourceServiceBroker	getDefaultResourceServiceBroker(ComponentManager componentManager)	Returns the singleton ResourceServiceBroker instance from either componentManager or HippoServiceRegistry.
static <T> T	getModuleComponent(String name)	Deprecated. Use getModuleComponent(ComponentManager, String) instead.
static <T> T	getModuleComponent(ComponentManager componentManager, String componentName)	Returns a component registered in CRISP HST Addon Module's ComponentManager.

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_NAME

public static final String MODULE_NAME

CRISP HST Addon Module name.

See Also:

Constant Field Values

Method Detail

getModuleComponent

public static <T> T getModuleComponent(ComponentManager componentManager,
                                       String componentName)

Returns a component registered in CRISP HST Addon Module's ComponentManager.

Parameters:

componentManager - the ComponentManager that initialized the CRISP HST Addon Module, normally gotten from HstServices.getComponentManager()

componentName - component name

Returns:

a component registered in CRISP HST Addon Module's ComponentManager

getModuleComponent

@Deprecated
public static <T> T getModuleComponent(String name)

Deprecated.

Use getModuleComponent(ComponentManager, String) instead.

Returns a component registered in CRISP HST Addon Module's ComponentManager.

Parameters:

name - a component bean name registered in CRISP HST Addon Module's ComponentManager

Returns:

a component registered in CRISP HST Addon Module's ComponentManager

getDefaultResourceServiceBroker

public static ResourceServiceBroker getDefaultResourceServiceBroker(ComponentManager componentManager)

Returns the singleton ResourceServiceBroker instance from either componentManager or HippoServiceRegistry.

Parameters:

componentManager - ComponentManager instance, normally gotten from HstServices.getComponentManager()

Returns:

the singleton ResourceServiceBroker instance

getDefaultResourceServiceBroker

@Deprecated
public static ResourceServiceBroker getDefaultResourceServiceBroker()

Deprecated.

Use getDefaultResourceServiceBroker(ComponentManager) instead.

Returns the singleton ResourceServiceBroker instance.

Returns:

the singleton ResourceServiceBroker instance