A B C D E F G H I K L M N O P Q R S T U V

A

add(Node) - Method in class org.jboss.shotoku.NodeList

Adds the given node to the node list.

add(BooleanNodeFilter) - Method in class org.jboss.shotoku.search.MultiBooleanNodeFilter

add(SearchParameter) - Method in class org.jboss.shotoku.search.Search

add(K) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

addAdministratedService(AdministratedServiceGetter) - Method in interface org.jboss.shotoku.service.ShotokuService

addAdministratedService(AdministratedServiceGetter) - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

addAll(NodeList) - Method in class org.jboss.shotoku.NodeList

Adds nodes from the given node list to this node list.

addAll(Collection<? extends Node>) - Method in class org.jboss.shotoku.NodeList

addAll(Collection<? extends K>) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

addPaths(String, String) - Static method in class org.jboss.shotoku.tools.Tools

Concatenates two parts of a path into 1: returns a string path1/path2.

addWatchedPath(K, String) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcher

Adds a path to the watched resources.

AdministratedService - Interface in org.jboss.shotoku.service

A base class for services that can be started and stopped via the ShotokuAdmin web application and are periodically updated.

AdministratedServiceGetter - Class in org.jboss.shotoku.service

AdministratedServiceGetter() - Constructor for class org.jboss.shotoku.service.AdministratedServiceGetter

AdministratedServiceImpl - Class in org.jboss.shotoku.service

AdministratedServiceImpl() - Constructor for class org.jboss.shotoku.service.AdministratedServiceImpl

afterCreate() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

afterDestroy() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

afterStart() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

AndNodeFilter - Class in org.jboss.shotoku.search

AndNodeFilter() - Constructor for class org.jboss.shotoku.search.AndNodeFilter

asByteArray() - Method in class org.jboss.shotoku.common.content.FileNodeContent

asByteArray() - Method in class org.jboss.shotoku.common.content.NodeContent

asInputStream() - Method in class org.jboss.shotoku.common.content.FileNodeContent

asInputStream() - Method in class org.jboss.shotoku.common.content.NodeContent

asString() - Method in class org.jboss.shotoku.common.content.FileNodeContent

asString() - Method in class org.jboss.shotoku.common.content.NodeContent

B

BooleanNodeFilter - Class in org.jboss.shotoku.search

BooleanNodeFilter() - Constructor for class org.jboss.shotoku.search.BooleanNodeFilter

C

CacheException - Exception in org.jboss.shotoku.exceptions

CacheException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.CacheException

CacheException(String) - Constructor for exception org.jboss.shotoku.exceptions.CacheException

CacheException() - Constructor for exception org.jboss.shotoku.exceptions.CacheException

ChangeType - Enum in org.jboss.shotoku.cache

Describes the possible type of changes which can be made on a resource.

checkName(String) - Static method in class org.jboss.shotoku.tools.Tools

clear() - Method in class org.jboss.shotoku.NodeList

clear() - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

concatenatePaths(String, String) - Static method in class org.jboss.shotoku.tools.Tools

Concatenates two parts of a path into 1: returns a string path1/path2, only with the necessary slashes (so running normalizeSlashes(String) won't have any effect on the string).

concatenateProperties(String, String) - Static method in class org.jboss.shotoku.tools.Tools

Concatenates two parts of a property name: returns a string property1.property2.

ConcurrentHashSet<K> - Class in org.jboss.shotoku.tools

ConcurrentHashSet() - Constructor for class org.jboss.shotoku.tools.ConcurrentHashSet

ConcurrentSet<K> - Interface in org.jboss.shotoku.tools

Constants - Class in org.jboss.shotoku.tools

Constatns used in Shotoku classes.

Constants() - Constructor for class org.jboss.shotoku.tools.Constants

contains(Object) - Method in class org.jboss.shotoku.NodeList

contains(Object) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

containsAll(Collection<?>) - Method in class org.jboss.shotoku.NodeList

containsAll(Collection<?>) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

ContentManager - Class in org.jboss.shotoku

A base class which provides access to nodes and directories.

ContentManager(String, String) - Constructor for class org.jboss.shotoku.ContentManager

Standard constructor.

contentManagersImplementations - Static variable in class org.jboss.shotoku.ContentManager

Map (content manager id -> pair (content manager class name, content manager configuration)

CopyException - Exception in org.jboss.shotoku.exceptions

CopyException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.CopyException

CopyException(String) - Constructor for exception org.jboss.shotoku.exceptions.CopyException

CopyException() - Constructor for exception org.jboss.shotoku.exceptions.CopyException

copyFrom(NodeContent) - Method in class org.jboss.shotoku.common.content.NodeContent

Copies content to from the given object.

copyTo(Directory, String, String) - Method in interface org.jboss.shotoku.Resource

Copies this resource to the given directory.

copyToFile(File) - Method in class org.jboss.shotoku.common.content.NodeContent

copyToFile(String) - Method in interface org.jboss.shotoku.Node

Copies this node's content to the given file.

create() - Method in interface org.jboss.shotoku.service.AdministratedService

create() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

create() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

createTemporaryFile() - Static method in class org.jboss.shotoku.tools.Tools

D

DateSortParameter - Class in org.jboss.shotoku.search

DateSortParameter() - Constructor for class org.jboss.shotoku.search.DateSortParameter

decodeURL(String) - Static method in class org.jboss.shotoku.tools.Tools

Decodes the given string from aa URL-friendly format (calls URLDecoder.decodeURL).

DEFAULT_ID - Static variable in class org.jboss.shotoku.tools.Constants

DEFAULT_SERVICE_INTERVAL - Static variable in class org.jboss.shotoku.tools.Constants

DEFAULT_TRANSFER_BUF_SIZE - Static variable in class org.jboss.shotoku.tools.Constants

delete(Collection<Resource>) - Method in class org.jboss.shotoku.ContentManager

Deletes the given resources at one time.

delete(Resource) - Method in class org.jboss.shotoku.ContentManager

Deletes the given resource.

delete(Resource...) - Method in class org.jboss.shotoku.ContentManager

Deletes the given resources at one time.

delete() - Method in interface org.jboss.shotoku.Resource

Deletes this node or directory (immediately, no save() is needed).

DeleteException - Exception in org.jboss.shotoku.exceptions

DeleteException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.DeleteException

DeleteException(String) - Constructor for exception org.jboss.shotoku.exceptions.DeleteException

DeleteException() - Constructor for exception org.jboss.shotoku.exceptions.DeleteException

deleteProperty(String) - Method in interface org.jboss.shotoku.Resource

Deletes the the given property.

deleteWatchedPath(K, String) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcher

destroy() - Method in interface org.jboss.shotoku.service.AdministratedService

destroy() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

destroy() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

destroy() - Method in class org.jboss.shotoku.web.FilesFromRepoFilter

Directory - Interface in org.jboss.shotoku

Interface that must be implemented by classes which represent directories, that is resources, which can contain other directories and nodes.

DirectoryIncludeParameter - Class in org.jboss.shotoku.search

A search parameter which includes to the result all nodes from a directory.

DirectoryIncludeParameter(Directory) - Constructor for class org.jboss.shotoku.search.DirectoryIncludeParameter

DirectoryIncludeParameter(Map<String, String>) - Constructor for class org.jboss.shotoku.search.DirectoryIncludeParameter

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.jboss.shotoku.web.FilesFromRepoFilter

E

encodeURL(String) - Static method in class org.jboss.shotoku.tools.Tools

Encodes the given string to an URL-friendly format (calls URLEncoder.encodeURL).

equals(Object) - Method in class org.jboss.shotoku.service.AdministratedServiceGetter

equals(Object) - Method in class org.jboss.shotoku.service.Null

equals(Object) - Method in class org.jboss.shotoku.tools.KeyValue

equals(Object) - Method in class org.jboss.shotoku.tools.Pair

equals(Object) - Method in class org.jboss.shotoku.tools.Triple

F

FALSE - Static variable in class org.jboss.shotoku.tools.Constants

A string denoting "false" value.

FileNodeContent - Class in org.jboss.shotoku.common.content

A subclass of NodeContent, which reads content from a given file, if the content is unchanged (so on first content set, this will start behaving like an ordinary NodeContent).

FileNodeContent(File) - Constructor for class org.jboss.shotoku.common.content.FileNodeContent

FilesFromRepoFilter - Class in org.jboss.shotoku.web

A filter for reading JSP (and html, text etc) files from a file repository and including them in the response.

FilesFromRepoFilter() - Constructor for class org.jboss.shotoku.web.FilesFromRepoFilter

filterNode(Node) - Method in class org.jboss.shotoku.search.BooleanNodeFilter

filterNode(Node) - Method in class org.jboss.shotoku.search.NodeFilter

Filters the given node.

filters - Variable in class org.jboss.shotoku.search.MultiBooleanNodeFilter

finalize() - Method in class org.jboss.shotoku.common.content.NodeContent

G

get(Object) - Static method in class org.jboss.shotoku.cache.ShotokuCache

Gets an object from the cache, which is bound to the given key.

get(K) - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Gets an object that is bound to the given key in the cache.

get(int) - Method in class org.jboss.shotoku.NodeList

Gets the i-th element of the list.

get(Object) - Method in interface org.jboss.shotoku.service.ShotokuService

get(Object) - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getAdministratedServices() - Method in interface org.jboss.shotoku.service.ShotokuService

getAdministratedServices() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getAllRevisions() - Method in interface org.jboss.shotoku.History

Gets a list of all nodes in this history.

getAttributeValue(Node, String) - Static method in class org.jboss.shotoku.tools.Tools

From the given node, gets the value of the specified attribute.

getChanged() - Method in class org.jboss.shotoku.common.content.NodeContent

getConfigFileName() - Method in class org.jboss.shotoku.cache.ShotokuPropertiesWatcher

getContent() - Method in interface org.jboss.shotoku.Node

Gets the content of this node, represented as a string.

getContentByteArray() - Method in interface org.jboss.shotoku.Node

Gets the content of this node as a byte array.

getContentInputStream() - Method in interface org.jboss.shotoku.Node

Gets the content of this node as an input stream.

getContentManager(K) - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Use this to bind a content manager with a key.

getContentManager() - Static method in class org.jboss.shotoku.ContentManager

Gets a content manager with a default id and an empty prefix.

getContentManager(String) - Static method in class org.jboss.shotoku.ContentManager

Gets a content manager with a default id and the given prefix.

getContentManager(String, String) - Static method in class org.jboss.shotoku.ContentManager

Gets a content manager with the given id and prefix.

getContentManager() - Method in interface org.jboss.shotoku.Resource

Gets the content manager from which this resource was obtained from.

getCreated() - Method in interface org.jboss.shotoku.Node

Gets the time of creation of this node.

getCreatedDate() - Method in interface org.jboss.shotoku.Node

Gets the time of creation of this node, represented as a date object.

getDefaultServiceInterval() - Static method in class org.jboss.shotoku.ContentManager

Gets the default Shotoku service interval.

getDirectories() - Method in interface org.jboss.shotoku.Directory

Gets a list of directories that are contained in this directory.

getDirectory(String) - Method in class org.jboss.shotoku.ContentManager

Gets a directory which can be found under the given path (to get nodes from subdirectories, use / to separate them).

getDirectory(String) - Method in interface org.jboss.shotoku.Directory

Gets a node from the given directory with the given name.

getFileBytes(File) - Static method in class org.jboss.shotoku.tools.Tools

getFileString(File) - Static method in class org.jboss.shotoku.tools.Tools

getFirst() - Method in class org.jboss.shotoku.tools.KeyValue

getFirst() - Method in class org.jboss.shotoku.tools.Pair

getFirst() - Method in class org.jboss.shotoku.tools.Triple

getFullName() - Method in interface org.jboss.shotoku.Resource

Gets the full name of this resource, that is, path to this resource relative to the content manager this node was read from.

getHistory() - Method in interface org.jboss.shotoku.Node

Gets a history of this node.

getId() - Method in class org.jboss.shotoku.ContentManager

Gets the id of this repository.

getInstance() - Static method in class org.jboss.shotoku.service.Null

getLastModification() - Method in interface org.jboss.shotoku.Resource

Gets the last modification time of this node.

getLastModificationDate() - Method in interface org.jboss.shotoku.Resource

Gets the last modification time of this node, represented as a date object.

getLastModified(Resource) - Method in class org.jboss.shotoku.velocity.ShotokuResourceLoader

getLastUpdate() - Method in interface org.jboss.shotoku.service.AdministratedService

getLastUpdate() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

getLastUpdateDate() - Method in interface org.jboss.shotoku.service.AdministratedService

getLastUpdateDate() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

getLength() - Method in class org.jboss.shotoku.common.content.FileNodeContent

getLength() - Method in class org.jboss.shotoku.common.content.NodeContent

getLength() - Method in interface org.jboss.shotoku.Node

Gets the length of this node's content.

getLogMessage() - Method in interface org.jboss.shotoku.Node

Gets a log message with which this node/ directory was saved.

getMapFromNodeAttributes(Node) - Static method in class org.jboss.shotoku.tools.Tools

Reads all attributes of the given node and returns them as a map.

getMimeType() - Method in interface org.jboss.shotoku.Node

Gets the mime type of this node.

getName() - Method in interface org.jboss.shotoku.Resource

Gets the name of this resource (node/ directory).

getNameBasedMimeType(String) - Static method in class org.jboss.shotoku.tools.Tools

getNameBasedMimeType(File) - Static method in class org.jboss.shotoku.tools.Tools

getNamedNode(Node, String) - Static method in class org.jboss.shotoku.tools.Tools

getNextKeyBase() - Method in interface org.jboss.shotoku.service.ShotokuService

Gets a next unique key base for a shotoku cache item.

getNextKeyBase() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getNode(String) - Method in class org.jboss.shotoku.ContentManager

Gets the most recent version of a node which can be found under the given path (to get nodes from subdirectories, use / to separate them).

getNode(String) - Method in interface org.jboss.shotoku.Directory

Gets a node from the given directory with the given name.

getNodeAtRevision(int) - Method in interface org.jboss.shotoku.History

Gets a node with a given revision.

getNodes() - Method in interface org.jboss.shotoku.Directory

Gets a list of nodes that are contained in this directory.

getOutputStream() - Method in class org.jboss.shotoku.common.content.NodeContent

getOutputStream() - Method in interface org.jboss.shotoku.Node

Gets an output stream for writing data to the node.

getParent() - Method in interface org.jboss.shotoku.Resource

Gets a directory to which this node/ directory belongs.

getPrefix() - Method in class org.jboss.shotoku.ContentManager

Gets the prefix of this content manager.

getProperties() - Method in interface org.jboss.shotoku.Resource

Gets a map of all properties associated with this resource.

getProperty(String, long) - Static method in class org.jboss.shotoku.ContentManager

Gets a property of this content manager, as it is written in the configuration file (helper method for implementations).

getProperty(String, int) - Static method in class org.jboss.shotoku.ContentManager

Gets a property of this content manager, as it is written in the configuration file (helper method for implementations).

getProperty(String, String) - Static method in class org.jboss.shotoku.ContentManager

Gets a property of this content manager, as it is written in the configuration file (helper method for implementations).

getProperty(String) - Method in interface org.jboss.shotoku.Resource

Gets the value of the given property.

getResourceStream(String) - Method in class org.jboss.shotoku.velocity.ShotokuResourceLoader

getRevisionNumber() - Method in interface org.jboss.shotoku.Node

Gets the revision number of this node.

getRevisionsCount() - Method in interface org.jboss.shotoku.History

Gets the number of revisions of this node's history.

getRootDirectory() - Method in class org.jboss.shotoku.ContentManager

Gets a root directory that is represented by this content manager.

getSecond() - Method in class org.jboss.shotoku.tools.KeyValue

getSecond() - Method in class org.jboss.shotoku.tools.Pair

getSecond() - Method in class org.jboss.shotoku.tools.Triple

getService() - Method in class org.jboss.shotoku.service.AdministratedServiceGetter

getService() - Static method in class org.jboss.shotoku.tools.Tools

getServiceDescription() - Method in interface org.jboss.shotoku.service.AdministratedService

getServiceDescription() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getServiceId() - Method in interface org.jboss.shotoku.service.AdministratedService

getServiceId() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getServiceInstance() - Method in interface org.jboss.shotoku.service.AdministratedService

getServiceInstance() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getServiceName() - Method in interface org.jboss.shotoku.service.AdministratedService

getServiceName() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

getServiceRunnable() - Method in interface org.jboss.shotoku.service.AdministratedService

getServiceRunnable() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

getThird() - Method in class org.jboss.shotoku.tools.Triple

getTimerInterval() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

getTransferBufferSize() - Static method in class org.jboss.shotoku.ContentManager

Gets the transfer buffer size.

getVelocityEngine() - Method in class org.jboss.shotoku.ContentManager

Gets a velocity engine, initialized with default properties, as defined in velocity.properties in the shotoku-base jar.

getVelocityEngine(boolean) - Method in class org.jboss.shotoku.ContentManager

Gets a velocity engine, initialized with default properties, as defined in velocity.properties in the shotoku-base jar.

getVelocityEngine(Map<? extends Object, ? extends Object>, boolean) - Method in class org.jboss.shotoku.ContentManager

Gets a velocity engine, initialized with default properties, overwritten by the given propeties.

H

hashCode() - Method in class org.jboss.shotoku.service.AdministratedServiceGetter

hashCode() - Method in class org.jboss.shotoku.service.Null

hashCode() - Method in class org.jboss.shotoku.tools.KeyValue

hashCode() - Method in class org.jboss.shotoku.tools.Pair

hashCode() - Method in class org.jboss.shotoku.tools.Triple

hasIndex(String) - Method in interface org.jboss.shotoku.Directory

Checks if an index is created on the given property.

hasModifications() - Method in interface org.jboss.shotoku.Resource

Checks if this resource has any modifications (that is, if any of its properties are changed, or content; new resources will always return "true" before a save).

History - Interface in org.jboss.shotoku

An interface that should be implemented by classes which represent a node's history.

HistoryIncludeParameter - Class in org.jboss.shotoku.search

A search parameter which includes to the result all nodes from the history of a given node.

HistoryIncludeParameter(History) - Constructor for class org.jboss.shotoku.search.HistoryIncludeParameter

HistoryIncludeParameter(Node) - Constructor for class org.jboss.shotoku.search.HistoryIncludeParameter

HistoryIncludeParameter(Map<String, String>) - Constructor for class org.jboss.shotoku.search.HistoryIncludeParameter

I

init(K) - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Called when the user demanded an object which hasn't been accessed before, and thus, which hasn't been yet initialized.

init(K) - Method in class org.jboss.shotoku.cache.ShotokuPropertiesWatcher

init(ExtendedProperties) - Method in class org.jboss.shotoku.velocity.ShotokuResourceLoader

init(FilterConfig) - Method in class org.jboss.shotoku.web.FilesFromRepoFilter

initContentManager(K) - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Called when getContentManager(key) is called for the first time.

initializeContentManager(String) - Static method in class org.jboss.shotoku.ContentManager

isEmbedded() - Static method in class org.jboss.shotoku.ContentManager

Checks if Shotoku is configured to run in embedded mode or not.

isEmpty() - Method in class org.jboss.shotoku.NodeList

isEmpty() - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

isEmpty(String) - Static method in class org.jboss.shotoku.tools.Tools

Checks if the given string is empty (null or "").

isLarge() - Method in class org.jboss.shotoku.common.content.NodeContent

isOutsideLink(String) - Static method in class org.jboss.shotoku.tools.Tools

Checks if the link is an outside link.

isSourceModified(Resource) - Method in class org.jboss.shotoku.velocity.ShotokuResourceLoader

isTrue(String) - Static method in class org.jboss.shotoku.tools.Tools

Checks if the given string represents a true value.

iterator() - Method in class org.jboss.shotoku.NodeList

iterator() - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

K

KeyValue<T1,T2> - Class in org.jboss.shotoku.tools

A pair of objects, but only the first one is considered in the equals() and hashCode() methods.

KeyValue(T1, T2) - Constructor for class org.jboss.shotoku.tools.KeyValue

L

limit(int) - Method in class org.jboss.shotoku.NodeList

Limits the size of this node list.

LimitParameter - Class in org.jboss.shotoku.search

A search parameter which truncates the number of nodes in the result to the given parameter.

LimitParameter(int) - Constructor for class org.jboss.shotoku.search.LimitParameter

LimitParameter(Map<String, String>) - Constructor for class org.jboss.shotoku.search.LimitParameter

M

markUnchanged() - Method in class org.jboss.shotoku.common.content.NodeContent

Makes the content marked as not-changed.

MoveException - Exception in org.jboss.shotoku.exceptions

MoveException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.MoveException

MoveException(String) - Constructor for exception org.jboss.shotoku.exceptions.MoveException

MoveException() - Constructor for exception org.jboss.shotoku.exceptions.MoveException

moveTo(Directory, String) - Method in interface org.jboss.shotoku.Resource

Moves this resource to the given directory.

MultiBooleanNodeFilter - Class in org.jboss.shotoku.search

MultiBooleanNodeFilter() - Constructor for class org.jboss.shotoku.search.MultiBooleanNodeFilter

N

NameFormatException - Exception in org.jboss.shotoku.exceptions

Thrown when the user attempts to create a resource with an invalid name, for example, one which contains a space.

NameFormatException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.NameFormatException

NameFormatException(String) - Constructor for exception org.jboss.shotoku.exceptions.NameFormatException

NameFormatException() - Constructor for exception org.jboss.shotoku.exceptions.NameFormatException

newDirectory(String) - Method in interface org.jboss.shotoku.Directory

Creates a new directory in this directory.

newNode(String) - Method in interface org.jboss.shotoku.Directory

Creates and returns a new node in this directory.

Node - Interface in org.jboss.shotoku

An interface which should be implemented by classes representing a node, that is a resource, which is versionable and has some text content.

NodeContent - Class in org.jboss.shotoku.common.content

Node content helper class, for converting between various formats.

NodeContent() - Constructor for class org.jboss.shotoku.common.content.NodeContent

NodeContent(byte[]) - Constructor for class org.jboss.shotoku.common.content.NodeContent

NodeFilter - Class in org.jboss.shotoku.search

NodeFilter() - Constructor for class org.jboss.shotoku.search.NodeFilter

NodeList - Class in org.jboss.shotoku

A class representing a list of nodes and providing the possibility to manipulate these nodes.

NodeList() - Constructor for class org.jboss.shotoku.NodeList

NodeList(List<Node>) - Constructor for class org.jboss.shotoku.NodeList

NodeReadOnly - Exception in org.jboss.shotoku.exceptions

NodeReadOnly() - Constructor for exception org.jboss.shotoku.exceptions.NodeReadOnly

normalizeSlashes(String, boolean) - Static method in class org.jboss.shotoku.tools.Tools

From the given string, removes unnecessary / in the middle and ending.

Null - Class in org.jboss.shotoku.service

A class that represents a "null" value - it is needed as nulls can't be stored as values in a ConcurrentHashMap.

O

objectsEqual(Object, Object) - Static method in class org.jboss.shotoku.tools.Tools

Checks if two objects are equal - either both null, or their equals method returns true.

org.jboss.shotoku - package org.jboss.shotoku

org.jboss.shotoku.cache - package org.jboss.shotoku.cache

org.jboss.shotoku.common.content - package org.jboss.shotoku.common.content

org.jboss.shotoku.exceptions - package org.jboss.shotoku.exceptions

org.jboss.shotoku.search - package org.jboss.shotoku.search

org.jboss.shotoku.service - package org.jboss.shotoku.service

org.jboss.shotoku.tools - package org.jboss.shotoku.tools

org.jboss.shotoku.velocity - package org.jboss.shotoku.velocity

org.jboss.shotoku.web - package org.jboss.shotoku.web

OrNodeFilter - Class in org.jboss.shotoku.search

OrNodeFilter() - Constructor for class org.jboss.shotoku.search.OrNodeFilter

P

Pair<T1,T2> - Class in org.jboss.shotoku.tools

A pair of objects.

Pair(T1, T2) - Constructor for class org.jboss.shotoku.tools.Pair

perform(ContentManager) - Method in class org.jboss.shotoku.search.Search

PROPERTIES_EMBEDDED - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_FILE - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_ID_DEFAULT - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_IDS - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_IMPL_SUFFIX - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_INTERNAL - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_PREFIX - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_SERVICE_INTERVAL - Static variable in class org.jboss.shotoku.tools.Constants

PROPERTIES_TRANSFER_BUF_SIZE - Static variable in class org.jboss.shotoku.tools.Constants

PropertySortParameter - Class in org.jboss.shotoku.search

PropertySortParameter(Map<String, String>) - Constructor for class org.jboss.shotoku.search.PropertySortParameter

PropertySortParameter(String, boolean) - Constructor for class org.jboss.shotoku.search.PropertySortParameter

PropertyValueParameter - Class in org.jboss.shotoku.search

PropertyValueParameter(Map<String, String>) - Constructor for class org.jboss.shotoku.search.PropertyValueParameter

PropertyValueParameter(String, String) - Constructor for class org.jboss.shotoku.search.PropertyValueParameter

put(Object, Object) - Static method in class org.jboss.shotoku.cache.ShotokuCache

Places the given object in the cache, binding it with the given key.

put(K, T) - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Binds the given key with the given object in the cache.

put(Object, Object) - Method in interface org.jboss.shotoku.service.ShotokuService

put(Object, Object) - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

Q

qualifyNode(Node) - Method in class org.jboss.shotoku.search.AndNodeFilter

qualifyNode(Node) - Method in class org.jboss.shotoku.search.BooleanNodeFilter

qualifyNode(Node) - Method in class org.jboss.shotoku.search.OrNodeFilter

qualifyNode(Node) - Method in class org.jboss.shotoku.search.PropertyValueParameter

R

register(ShotokuCacheItem) - Method in interface org.jboss.shotoku.service.ShotokuService

register(ShotokuCacheItem) - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

remove(Object) - Static method in class org.jboss.shotoku.cache.ShotokuCache

Removes a binding for the key in the cache, in one exists.

remove() - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Removes all keys handled by this ShotokuCacheItem from the cache.

remove(Object) - Method in class org.jboss.shotoku.NodeList

remove(Object) - Method in interface org.jboss.shotoku.service.ShotokuService

remove(Object) - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

remove(Object) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

removeAll(Collection<?>) - Method in class org.jboss.shotoku.NodeList

removeAll(Collection<?>) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

RepositoryException - Exception in org.jboss.shotoku.exceptions

RepositoryException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.RepositoryException

RepositoryException(String) - Constructor for exception org.jboss.shotoku.exceptions.RepositoryException

resetWatchedPaths(K) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcher

Resource - Interface in org.jboss.shotoku

Common parts of nodes and directories interfaces.

ResourceAlreadyExists - Exception in org.jboss.shotoku.exceptions

ResourceAlreadyExists(String) - Constructor for exception org.jboss.shotoku.exceptions.ResourceAlreadyExists

ResourceDeleted - Exception in org.jboss.shotoku.exceptions

ResourceDeleted(String) - Constructor for exception org.jboss.shotoku.exceptions.ResourceDeleted

ResourceDeleted() - Constructor for exception org.jboss.shotoku.exceptions.ResourceDeleted

ResourceDoesNotExist - Exception in org.jboss.shotoku.exceptions

ResourceDoesNotExist(String) - Constructor for exception org.jboss.shotoku.exceptions.ResourceDoesNotExist

retainAll(Collection<?>) - Method in class org.jboss.shotoku.NodeList

retainAll(Collection<?>) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

S

save(String, Collection<Resource>) - Method in class org.jboss.shotoku.ContentManager

Saves the given resources at one time.

save(String, Resource) - Method in class org.jboss.shotoku.ContentManager

Saves the given resource.

save(String, Resource...) - Method in class org.jboss.shotoku.ContentManager

Saves the given resources at one time.

save(String, Resource, Resource) - Method in class org.jboss.shotoku.ContentManager

Saves the given resources at one time.

save(String, Resource, Resource, Resource) - Method in class org.jboss.shotoku.ContentManager

Saves the given resources at one time.

save(String, Resource, Resource, Resource, Resource) - Method in class org.jboss.shotoku.ContentManager

Saves the given resources at one time.

save(String, Resource, Resource, Resource, Resource, Resource) - Method in class org.jboss.shotoku.ContentManager

Saves the given resources at one time.

save(String) - Method in interface org.jboss.shotoku.Resource

Saves modified properties and possibly content (in case of nodes).

SaveException - Exception in org.jboss.shotoku.exceptions

SaveException(Exception) - Constructor for exception org.jboss.shotoku.exceptions.SaveException

SaveException(String) - Constructor for exception org.jboss.shotoku.exceptions.SaveException

SaveException() - Constructor for exception org.jboss.shotoku.exceptions.SaveException

search(Search) - Method in class org.jboss.shotoku.ContentManager

Performs the given search in this content manager.

Search - Class in org.jboss.shotoku.search

A class representing a search or a sub-search.

Search() - Constructor for class org.jboss.shotoku.search.Search

SearchParameter - Interface in org.jboss.shotoku.search

setContent(InputStream) - Method in class org.jboss.shotoku.common.content.NodeContent

setContent(String) - Method in class org.jboss.shotoku.common.content.NodeContent

setContent(byte[]) - Method in class org.jboss.shotoku.common.content.NodeContent

setContent(String) - Method in interface org.jboss.shotoku.Node

Sets the content of this node.

setContent(InputStream) - Method in interface org.jboss.shotoku.Node

Sets this node's content, reading from the given input stream.

setContent(byte[]) - Method in interface org.jboss.shotoku.Node

Sets this node's content, given as an array of bytes.

setIndex(String, boolean) - Method in interface org.jboss.shotoku.Directory

Creates or deletes an index on a property.

setLastUpdate(long) - Method in interface org.jboss.shotoku.service.AdministratedService

setLastUpdate(long) - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

setProperty(String, String) - Method in interface org.jboss.shotoku.Resource

Sets the value of the given property.

setServiceRunnable(boolean) - Method in interface org.jboss.shotoku.service.AdministratedService

setServiceRunnable(boolean) - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

setTimerInterval(long) - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

setup() - Static method in class org.jboss.shotoku.ContentManager

Setups the content managers before first used.

SETUP_FUNCTION - Static variable in class org.jboss.shotoku.tools.Constants

SHOTOKU_CACHE_KEY_BASE - Static variable in class org.jboss.shotoku.tools.Constants

Default key base prefix.

SHOTOKU_SERVICE_NAME - Static variable in class org.jboss.shotoku.tools.Constants

SHOTOKU_SERVICE_NAME - name under which the shotoku service is registered.

ShotokuCache - Class in org.jboss.shotoku.cache

A global cache.

ShotokuCache() - Constructor for class org.jboss.shotoku.cache.ShotokuCache

ShotokuCacheItem<K,T> - Class in org.jboss.shotoku.cache

Extend this class if you want to store objects in the cache that will be updated on every Shotoku service timer timeout.

ShotokuCacheItem(long) - Constructor for class org.jboss.shotoku.cache.ShotokuCacheItem

ShotokuCacheItem() - Constructor for class org.jboss.shotoku.cache.ShotokuCacheItem

ShotokuPropertiesWatcher<K> - Class in org.jboss.shotoku.cache

ShotokuPropertiesWatcher() - Constructor for class org.jboss.shotoku.cache.ShotokuPropertiesWatcher

ShotokuResourceLoader - Class in org.jboss.shotoku.velocity

ShotokuResourceLoader() - Constructor for class org.jboss.shotoku.velocity.ShotokuResourceLoader

ShotokuResourceWatcher<K,T> - Class in org.jboss.shotoku.cache

Extend this class if you want to store objects in the cache that will be updated whenever any of the watched resources in a content manager changes (a resource changes when it is added, deleted or modified).

ShotokuResourceWatcher(long) - Constructor for class org.jboss.shotoku.cache.ShotokuResourceWatcher

ShotokuResourceWatcher() - Constructor for class org.jboss.shotoku.cache.ShotokuResourceWatcher

ShotokuResourceWatcherSplitDescriptor<K,T> - Class in org.jboss.shotoku.cache

Same as ShotokuResourceWatcher but the update method has a different signature (the information about changes to resources is split into three sets).

ShotokuResourceWatcherSplitDescriptor() - Constructor for class org.jboss.shotoku.cache.ShotokuResourceWatcherSplitDescriptor

ShotokuService - Interface in org.jboss.shotoku.service

ShotokuServiceImpl - Class in org.jboss.shotoku.service

ShotokuServiceImpl() - Constructor for class org.jboss.shotoku.service.ShotokuServiceImpl

ShotokuServiceLocal - Interface in org.jboss.shotoku.service

size() - Method in class org.jboss.shotoku.NodeList

size() - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

sort(Comparator<Node>) - Method in class org.jboss.shotoku.NodeList

Sorts this node list with the given comparator.

SortParameter - Class in org.jboss.shotoku.search

A search parameter which sorts the result node list with the given comparator.

SortParameter(Comparator<Node>) - Constructor for class org.jboss.shotoku.search.SortParameter

start() - Method in interface org.jboss.shotoku.service.AdministratedService

start() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

start() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

startUpdateThread() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

stop() - Method in interface org.jboss.shotoku.service.AdministratedService

stop() - Method in class org.jboss.shotoku.service.AdministratedServiceImpl

T

toArray() - Method in class org.jboss.shotoku.NodeList

toArray(T[]) - Method in class org.jboss.shotoku.NodeList

toArray() - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

toArray(T[]) - Method in class org.jboss.shotoku.tools.ConcurrentHashSet

toList() - Method in class org.jboss.shotoku.NodeList

Gets an immutable java.util.List representation of this node list.

Tools - Class in org.jboss.shotoku.tools

Utility, helper functions used internally.

Tools() - Constructor for class org.jboss.shotoku.tools.Tools

toString() - Method in class org.jboss.shotoku.tools.Pair

toString(Object) - Static method in class org.jboss.shotoku.tools.Tools

Converts the given object to a String in a null-safe way.

toString() - Method in class org.jboss.shotoku.tools.Triple

toStringNotNull(Object) - Static method in class org.jboss.shotoku.tools.Tools

Converts the given object to a String in a null-safe way.

transfer(InputStream, OutputStream) - Static method in class org.jboss.shotoku.tools.Tools

Transferes all bytes from the given input stream to the given output stream.

transfer(InputStream, PrintWriter) - Static method in class org.jboss.shotoku.tools.Tools

Transferes all bytes from the given input stream to the given output stream.

transform(NodeList, ContentManager) - Method in class org.jboss.shotoku.search.DirectoryIncludeParameter

transform(NodeList, ContentManager) - Method in class org.jboss.shotoku.search.HistoryIncludeParameter

transform(NodeList, ContentManager) - Method in class org.jboss.shotoku.search.LimitParameter

transform(NodeList, ContentManager) - Method in class org.jboss.shotoku.search.NodeFilter

transform(NodeList, ContentManager) - Method in class org.jboss.shotoku.search.Search

transform(NodeList, ContentManager) - Method in interface org.jboss.shotoku.search.SearchParameter

transform(NodeList, ContentManager) - Method in class org.jboss.shotoku.search.SortParameter

Triple<T1,T2,T3> - Class in org.jboss.shotoku.tools

A triple of objects.

Triple(T1, T2, T3) - Constructor for class org.jboss.shotoku.tools.Triple

TRUE - Static variable in class org.jboss.shotoku.tools.Constants

A string denoting "true" value.

tuple(A, B) - Static method in class org.jboss.shotoku.tools.Tuples

tuple(A, B, C) - Static method in class org.jboss.shotoku.tools.Tuples

Tuples - Class in org.jboss.shotoku.tools

Tuples() - Constructor for class org.jboss.shotoku.tools.Tuples

U

unmarshallText(Node) - Static method in class org.jboss.shotoku.tools.Tools

Reads text contained in a tag of the form text.

update() - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Called by the Shotoku service.

update(K, T) - Method in class org.jboss.shotoku.cache.ShotokuCacheItem

Called by the service periodically to update the object held.

update(K, Properties, Map<String, ChangeType>) - Method in class org.jboss.shotoku.cache.ShotokuPropertiesWatcher

update(K, T) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcher

update(K, T, Map<String, ChangeType>) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcher

Same as ShotokuCacheItem.update(String, T), but is called only when some of the watched resources change, not on each call of update by the service.

update(K, T, Set<String>, Set<String>, Set<String>) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcherSplitDescriptor

Same as ShotokuCacheItem.update(String, T), but is called only when some of the watched resources change, not on each call of update by the service.

update(K, T, Map<String, ChangeType>) - Method in class org.jboss.shotoku.cache.ShotokuResourceWatcherSplitDescriptor

update() - Method in interface org.jboss.shotoku.service.AdministratedService

update() - Method in class org.jboss.shotoku.service.ShotokuServiceImpl

V

valueOf(String) - Static method in enum org.jboss.shotoku.cache.ChangeType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jboss.shotoku.cache.ChangeType

Returns an array containing the constants of this enum type, in the order they're declared.

VELOCITY_PROPERTIES_FILE - Static variable in class org.jboss.shotoku.tools.Constants

VELOCITY_RL_ID - Static variable in class org.jboss.shotoku.tools.Constants

VELOCITY_RL_PREFIX - Static variable in class org.jboss.shotoku.tools.Constants

A B C D E F G H I K L M N O P Q R S T U V