io.wcm.wcm.commons.util

Class RunMode

java.lang.Object

io.wcm.wcm.commons.util.RunMode

Deprecated.

Instead of directly using the run modes, it is better to make the component in question require a configuration (see OSGI Declarative Services Spec: configuration policy). In this case, a component gets only active if a configuration is available. Such a configuration can be put into the repository for the specific run mode.

@ProviderType
 @Deprecated
public final class RunMode
extends Object

Sling run mode utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHOR Deprecated. Runmode for author instance
static String	PUBLISH Deprecated. Runmode for publish instance

Method Summary

Modifier and Type	Method and Description
static boolean	disableIfNoRunModeActive(Set<String> runModes, String[] allowedRunModes, org.osgi.service.component.ComponentContext componentContext, org.slf4j.Logger log) Deprecated. Use this to disable a component if none of its run modes are active.
static boolean	disableIfNotAuthor(Set<String> runModes, org.osgi.service.component.ComponentContext componentContext, org.slf4j.Logger log) Deprecated. Use this to disable a component if the runmode "author" is not active.
static boolean	disableIfNotPublish(Set<String> runModes, org.osgi.service.component.ComponentContext componentContext, org.slf4j.Logger log) Deprecated. Use this to disable a component if the runmode "publish" is not active.
static boolean	is(Set<String> runModes, String... expectedRunModes) Deprecated. Checks if given run mode is active.
static boolean	isAuthor(Set<String> runModes) Deprecated. Checks if context is running on author instance.
static boolean	isPublish(Set<String> runModes) Deprecated. Checks if context is running on publish instance.

Methods inherited from class java.lang.Object

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

Field Detail

AUTHOR

public static final String AUTHOR

Deprecated.

Runmode for author instance

See Also:

Constant Field Values

PUBLISH

public static final String PUBLISH

Deprecated.

Runmode for publish instance

See Also:

Constant Field Values

Method Detail

is

public static boolean is(Set<String> runModes,
                         String... expectedRunModes)

Deprecated.

Checks if given run mode is active.

Parameters:

runModes - Run modes for current instance

expectedRunModes - Run mode(s) to check for

Returns:

true if any of the given run modes is active

isAuthor

public static boolean isAuthor(Set<String> runModes)

Deprecated.

Checks if context is running on author instance.

Parameters:

runModes - Run modes

Returns:

true if "author" run mode is active

isPublish

public static boolean isPublish(Set<String> runModes)

Deprecated.

Checks if context is running on publish instance.

Parameters:

runModes - Run modes

Returns:

true if "publish" run mode is active

disableIfNoRunModeActive

public static boolean disableIfNoRunModeActive(Set<String> runModes,
                                               String[] allowedRunModes,
                                               org.osgi.service.component.ComponentContext componentContext,
                                               org.slf4j.Logger log)

Deprecated.

Use this to disable a component if none of its run modes are active. Component activation status is logged with DEBUG level. This method is a replacement for the com.day.cq.commons.RunModeUtil#disableIfNoRunModeActive(RunMode, String[], ComponentContext, Logger) method which is deprecated.

Parameters:

runModes - Run modes

allowedRunModes - Allowed run modes

componentContext - OSGI component context

log - Logger

Returns:

true if component was disabled

disableIfNotAuthor

public static boolean disableIfNotAuthor(Set<String> runModes,
                                         org.osgi.service.component.ComponentContext componentContext,
                                         org.slf4j.Logger log)

Deprecated.

Use this to disable a component if the runmode "author" is not active. Component activation status is logged with DEBUG level. This method is a replacement for the com.day.cq.commons.RunModeUtil#disableIfNoRunModeActive(RunMode, String[], ComponentContext, Logger) method which is deprecated.

Parameters:

runModes - Run modes

componentContext - OSGI component context

log - Logger

Returns:

true if component was disabled

disableIfNotPublish

public static boolean disableIfNotPublish(Set<String> runModes,
                                          org.osgi.service.component.ComponentContext componentContext,
                                          org.slf4j.Logger log)

Deprecated.

Use this to disable a component if the runmode "publish" is not active. Component activation status is logged with DEBUG level. This method is a replacement for the com.day.cq.commons.RunModeUtil#disableIfNoRunModeActive(RunMode, String[], ComponentContext, Logger) method which is deprecated.

Parameters:

runModes - Run modes

componentContext - OSGI component context

log - Logger

Returns:

true if component was disabled