Package org.jboss.as.controller.services.path

Interface PathManager

All Known Implementing Classes:

PathManagerService

public interface PathManager

The client interface for the PathManagerService

Author:

Kabir Khan

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PathManager.Callback	A callback, see registerCallback(String, Callback, Event...)
static enum	PathManager.Event	An event triggered when changes are made to a path entry
static interface	PathManager.PathEventContext
static class	PathManager.ReloadServerCallback	Factory for a PathManager.Callback that always calls PathManager.PathEventContext.reloadRequired() from its PathManager.Callback.pathModelEvent(PathEventContext, String) method.

Field Summary

Fields

Modifier and Type	Field	Description
static final UnaryServiceDescriptor<String>	PATH_SERVICE_DESCRIPTOR
static final NullaryServiceDescriptor<PathManager>	SERVICE_DESCRIPTOR

Method Summary

Modifier and Type	Method	Description
PathEntry	getPathEntry(String name)	Gets a path entry
PathManager.Callback.Handle	registerCallback(String name, PathManager.Callback callback, PathManager.Event... events)	Registers a callback for when a path is added/changed/removed
String	resolveRelativePathEntry(String path, String relativeTo)	Resolves a relative path

Field Details

SERVICE_DESCRIPTOR

static final NullaryServiceDescriptor<PathManager> SERVICE_DESCRIPTOR

PATH_SERVICE_DESCRIPTOR

static final UnaryServiceDescriptor<String> PATH_SERVICE_DESCRIPTOR

Method Details

resolveRelativePathEntry

String resolveRelativePathEntry(String path,
 String relativeTo)

Resolves a relative path

Parameters:

path - an absolute path if relativeTo is null, the relative path to relativeTo otherwise

relativeTo - the name of the path this is relative to, may be null

Returns:

the resolved path

Throws:

IllegalStateException - if there is no path registered under relativeTo

getPathEntry

PathEntry getPathEntry(String name)

Gets a path entry

Parameters:

name - the name of the path

Returns:

the path

Throws:

IllegalStateException - if there is no path registered under path

registerCallback

PathManager.Callback.Handle registerCallback(String name,
 PathManager.Callback callback,
 PathManager.Event... events)

Registers a callback for when a path is added/changed/removed

Parameters:

name - the name of the path

callback - the callback instance that will be called when one of the events occur

events - the events we are interested in

Returns:

a handle to unregister the callback