Copyright© 2008-2022 Sitevision AB, all rights reserved.
Package | Description |
---|---|
javax.jcr |
Provides interfaces and classes for the Content Repository for Java Technology.
|
javax.jcr.lock |
Provides interfaces and classes for content repository locking functionality.
|
javax.jcr.nodetype |
This package provides interfaces and classes for content repository node type functionality.
|
javax.jcr.observation |
Provides interfaces and classes for content repository event observation
functionality.
|
javax.jcr.query |
Provides interfaces and classes for content repository searching functionality.
|
javax.jcr.query.qom |
Provides interfaces and classes for content repository Query Object Model.
|
javax.jcr.retention |
Provides interfaces and classes for content repository retention management
functionality.
|
javax.jcr.security |
Provides interfaces and classes for content repository access control management
functionality.
|
javax.jcr.util |
Provides utility classes for the content repository API.
|
javax.jcr.version |
Provides interfaces and classes for content repository versioning functionality.
|
senselogic.sitevision.api.collaboration |
Collaboration utility interfaces.
|
senselogic.sitevision.api.metadata |
Metadata utility interfaces
|
senselogic.sitevision.api.redirect |
Redirect utility interfaces.
|
senselogic.sitevision.api.render |
Rendering utility interfaces that might be needed when rendering
|
senselogic.sitevision.api.render.xslt |
XSLT rendering interfaces.
|
senselogic.sitevision.api.security |
Security utility interfaces
|
senselogic.sitevision.api.subscription |
Subscription and subscriber utility interfaces
|
senselogic.sitevision.api.tag |
Tag utility interfaces.
|
senselogic.sitevision.api.webresource |
Web resource (pages, articles, files and images) utility interfaces
|
senselogic.sitevision.api.webresource.structure |
Web resource structure and grouping utility interfaces
|
senselogic.sitevision.api.webresource.webcontent |
Web content (web content of pages, articles and templates) utility interfaces
|
senselogic.sitevision.api.versioning |
Versioning utility interfaces (including publish/unpublish facilities)
|
senselogic.sitevision.api.xml |
XML parser utility interfaces.
|
Modifier and Type | Class and Description |
---|---|
class |
AccessDeniedException
Exception thrown by access-related methods.
|
class |
InvalidItemStateException
Exception thrown by the write methods of
Node and Property
and by Session.save() and Session.refresh(boolean) if an attempted
change would conflict with a change to the persistent workspace made through
another Session . |
class |
InvalidLifecycleTransitionException
Exception thrown by Lifecycle management-related methods.
|
class |
InvalidSerializedDataException
Exception thrown by the deserialization methods of
Session if
the serialized data being input has an invalid format. |
class |
ItemExistsException
An exception thrown when an attempt is made to place an item in a position
where another item already exists.
|
class |
ItemNotFoundException
|
class |
LoginException
Exception thrown by
and if
the specified credentials are invalid. |
class |
MergeException
Exception thrown by
Node.merge(String srcWorkspace, boolean isDeep) . |
class |
NamespaceException
Exception thrown by
if the specified uri is not registered in
the NamespaceRegistry . |
class |
NoSuchWorkspaceException
Exception thrown by
when a specific workspace is not found. |
class |
PathNotFoundException
Exception thrown when no
Item exists at the specified path or
when the specified path implies intermediary Node s that do not
exist. |
class |
ReferentialIntegrityException
Exception thrown on referential integrity violation.
|
class |
UnsupportedRepositoryOperationException
Thrown by methods that are not supported by a particular implementation.
|
class |
ValueFormatException
Exception thrown when an attempt is made to assign a value to a property that
has an invalid format, given the type of the property.
|
Modifier and Type | Method and Description |
---|---|
void |
Item.accept(ItemVisitor visitor)
Accepts an
ItemVisitor . |
void |
Node.addMixin(String mixinName)
Adds the mixin node type named
mixinName to this node. |
Node |
Node.addNode(String relPath)
Creates a new node at
relPath . |
Node |
Node.addNode(String relPath,
String primaryNodeTypeName)
Creates a new node at
relPath of the specified node type. |
boolean |
Node.canAddMixin(String mixinName)
Returns
true if calling Node.addMixin(java.lang.String) on this node
with the mixn node type mixinName will not fail. |
void |
Node.cancelMerge(Version version)
Deprecated.
As of JCR 2.0,
VersionManager.cancelMerge(java.lang.String, javax.jcr.version.Version)
should be used instead. |
Version |
Node.checkin()
Deprecated.
As of JCR 2.0,
VersionManager.checkin(java.lang.String)
should be used instead. |
void |
Node.checkout()
Deprecated.
As of JCR 2.0,
VersionManager.checkout(java.lang.String)
should be used instead. |
void |
Session.checkPermission(String absPath,
String actions)
Determines whether this
Session has permission to perform
the specified actions at the specified absPath . |
void |
Workspace.clone(String srcWorkspace,
String srcAbsPath,
String destAbsPath,
boolean removeExisting)
Clones the subgraph at the node
srcAbsPath in
srcWorkspace to the new location at destAbsPath
in this workspace. |
void |
Workspace.copy(String srcAbsPath,
String destAbsPath)
This method copies the subgraph rooted at, and including, the node at
srcAbsPath to the new location at destAbsPath . |
void |
Workspace.copy(String srcWorkspace,
String srcAbsPath,
String destAbsPath)
This method copies the subgraph at
srcAbsPath in
srcWorkspace to destAbsPath in
this workspace. |
Binary |
ValueFactory.createBinary(InputStream stream)
Returns a
Binary object with a value consisting of the
content of the specified InputStream . |
Value |
ValueFactory.createValue(Node value)
|
Value |
ValueFactory.createValue(Node value,
boolean weak)
Returns a
Value object of PropertyType.REFERENCE (if
weak is false ) or PropertyType.REFERENCE (if weak is true ) that
holds the identifier of the specified Node . |
void |
Workspace.createWorkspace(String name)
Creates a new
Workspace with the specified
name . |
void |
Workspace.createWorkspace(String name,
String srcWorkspace)
Creates a new
Workspace with the specified name
initialized with a clone of the content of the workspace
srcWorkspace . |
void |
Workspace.deleteWorkspace(String name)
Deletes the workspace with the specified
name from the
repository, deleting all content within it. |
void |
Node.doneMerge(Version version)
Deprecated.
As of JCR 2.0,
VersionManager.doneMerge(java.lang.String, javax.jcr.version.Version)
should be used instead. |
void |
Session.exportDocumentView(String absPath,
ContentHandler contentHandler,
boolean skipBinary,
boolean noRecurse)
Serializes the node (and if
noRecurse is false ,
the whole subgraph) at absPath into a series of SAX events
by calling the methods of the supplied org.xml.sax.ContentHandler . |
void |
Session.exportDocumentView(String absPath,
OutputStream out,
boolean skipBinary,
boolean noRecurse)
Serializes the node (and if
noRecurse is false ,
the whole subgraph) at absPath as an XML stream and outputs
it to the supplied OutputStream . |
void |
Session.exportSystemView(String absPath,
ContentHandler contentHandler,
boolean skipBinary,
boolean noRecurse)
Serializes the node (and if
noRecurse is false ,
the whole subgraph) at absPath into a series of SAX events
by calling the methods of the supplied org.xml.sax.ContentHandler . |
void |
Session.exportSystemView(String absPath,
OutputStream out,
boolean skipBinary,
boolean noRecurse)
Serializes the node (and if
noRecurse is false ,
the whole subgraph) at absPath as an XML stream and outputs
it to the supplied OutputStream . |
void |
Node.followLifecycleTransition(String transition)
Causes the lifecycle state of this node to undergo the specified
transition . |
AccessControlManager |
Session.getAccessControlManager()
Returns the access control manager for this
Session . |
String[] |
Workspace.getAccessibleWorkspaceNames()
Returns a string array containing the names of all workspaces in this
repository that are accessible to this user, given the
Credentials that were used to get the Session
to which this Workspace is tied. |
String[] |
Node.getAllowedLifecycleTransistions()
Returns the list of valid state transitions for this node.
|
Item |
Item.getAncestor(int depth)
Returns the ancestor of this
Item at the specified depth. |
Version |
Node.getBaseVersion()
Deprecated.
As of JCR 2.0,
VersionManager.getBaseVersion(java.lang.String)
should be used instead. |
Binary |
Value.getBinary()
Returns a
Binary representation of this value. |
Binary |
Property.getBinary()
Returns a
Binary representation of the value of this
property. |
boolean |
Value.getBoolean()
Returns a
Boolean representation of this value. |
boolean |
Property.getBoolean()
Returns a
boolean representation of the value of this
property. |
String |
Node.getCorrespondingNodePath(String workspaceName)
Returns the absolute path of the node in the specified workspace that
corresponds to
this node. |
Calendar |
Value.getDate()
Returns a
Calendar representation of this value. |
Calendar |
Property.getDate()
Returns a
Calendar representation of the value of this
property. |
BigDecimal |
Value.getDecimal()
Returns a
BigDecimal representation of this value. |
BigDecimal |
Property.getDecimal()
Returns a
BigDecimal representation of the value of this
property. |
PropertyDefinition |
Property.getDefinition()
Returns the property definition that applies to this property.
|
NodeDefinition |
Node.getDefinition()
Returns the node definition that applies to this node.
|
int |
Item.getDepth()
Returns the depth of this
Item in the workspace item graph. |
double |
Value.getDouble()
Returns a
double representation of this value. |
double |
Property.getDouble()
Returns a
double representation of the value of this
property. |
String |
Node.getIdentifier()
Returns the identifier of this node.
|
ContentHandler |
Workspace.getImportContentHandler(String parentAbsPath,
int uuidBehavior)
Returns an
org.xml.sax.ContentHandler which can be used to
push SAX events into the repository. |
ContentHandler |
Session.getImportContentHandler(String parentAbsPath,
int uuidBehavior)
Returns an
org.xml.sax.ContentHandler which is used to push
SAX events to the repository. |
int |
Node.getIndex()
This method returns the index of this node within the ordered set of its
same-name sibling nodes.
|
Item |
Session.getItem(String absPath)
Returns the node at the specified absolute path in the workspace.
|
long |
Property.getLength()
Returns the length of the value of this property.
|
long[] |
Property.getLengths()
Returns an array holding the lengths of the values of this (multi-value)
property in bytes where each is individually calculated as described in
Property.getLength() . |
Lock |
Node.getLock()
Deprecated.
As of JCR 2.0,
LockManager.getLock(String) should be
used instead. |
LockManager |
Workspace.getLockManager()
Returns the
LockManager object, through which locking
methods are accessed. |
long |
Value.getLong()
Returns a
long representation of this value. |
long |
Property.getLong()
Returns a
long representation of the value of this property. |
NodeType[] |
Node.getMixinNodeTypes()
Returns an array of
NodeType objects representing the mixin
node types in effect for this node. |
String |
Item.getName()
Returns the name of this
Item in qualified form. |
String |
Session.getNamespacePrefix(String uri)
Returns the prefix to which the given
uri is mapped as
currently set in this Session . |
String[] |
Session.getNamespacePrefixes()
Returns all prefixes currently mapped to URIs in this
Session . |
NamespaceRegistry |
Workspace.getNamespaceRegistry()
Returns the
NamespaceRegistry object, which is used to
access the mapping between prefixes and namespaces. |
String |
Session.getNamespaceURI(String prefix)
Returns the URI to which the given
prefix is mapped as
currently set in this Session . |
Node |
Property.getNode()
If this property is of type
REFERENCE ,
WEAKREFERENCE or PATH (or convertible to one of
these types) this method returns the Node to which this
property refers. |
Node |
Session.getNode(String absPath)
Returns the node at the specified absolute path in the workspace.
|
Node |
Node.getNode(String relPath)
Returns the node at
relPath relative to this node. |
Node |
Session.getNodeByIdentifier(String id)
Returns the node specified by the given identifier.
|
Node |
Session.getNodeByUUID(String uuid)
Deprecated.
As of JCR 2.0,
Session.getNodeByIdentifier(String) should be
used instead. |
NodeIterator |
Node.getNodes()
Returns all child nodes of this node accessible through the current
Session . |
NodeIterator |
Node.getNodes(String namePattern)
Gets all child nodes of this node accessible through the current
Session that match namePattern . |
NodeIterator |
Node.getNodes(String[] nameGlobs)
Gets all child nodes of this node accessible through the current
Session that match one or more of the nameGlob
strings in the passed array. |
NodeTypeManager |
Workspace.getNodeTypeManager()
Returns the
NodeTypeManager through which node type
information can be queried. |
ObservationManager |
Workspace.getObservationManager()
Returns the
ObservationManager object. |
Node |
Item.getParent()
Returns the parent of this
Item . |
String |
Item.getPath()
Returns the normalized absolute path to this item.
|
String |
NamespaceRegistry.getPrefix(String uri)
Returns the prefix which is mapped to the given
uri . |
String[] |
NamespaceRegistry.getPrefixes()
Returns an array holding all currently registered prefixes.
|
Item |
Node.getPrimaryItem()
Returns the primary child item of this node.
|
NodeType |
Node.getPrimaryNodeType()
Returns the primary node type in effect for this node.
|
PropertyIterator |
Node.getProperties()
Returns all properties of this node accessible through the current
Session . |
PropertyIterator |
Node.getProperties(String namePattern)
Gets all properties of this node accessible through the current
Session that match namePattern . |
PropertyIterator |
Node.getProperties(String[] nameGlobs)
Gets all properties of this node accessible through the current
Session that match one or more of the nameGlob
strings in the passed array. |
Property |
Property.getProperty()
If this property is of type
PATH (or convertible to this
type) this method returns the Property to which this
property refers. |
Property |
Session.getProperty(String absPath)
Returns the property at the specified absolute path in the workspace.
|
Property |
Node.getProperty(String relPath)
Returns the property at
relPath relative to
this node. |
QueryManager |
Workspace.getQueryManager()
Returns the
QueryManager object, through search methods are
accessed. |
PropertyIterator |
Node.getReferences()
This method returns all
REFERENCE properties that refer to
this node and that are accessible through the current
Session . |
PropertyIterator |
Node.getReferences(String name)
This method returns all
REFERENCE properties that refer to
this node, have the specified name and that are accessible
through the current Session . |
Repository |
RepositoryFactory.getRepository(Map parameters)
Attempts to establish a connection to a repository using the given
parameters . |
RetentionManager |
Session.getRetentionManager()
Returns the retention and hold manager for this
Session . |
Node |
Session.getRootNode()
Returns the root node of the workspace, "/".
|
Session |
Item.getSession()
Returns the
Session through which this Item was
acquired. |
NodeIterator |
Node.getSharedSet()
Returns an iterator over all nodes that are in the shared set of this
node.
|
long |
Binary.getSize()
Returns the size of this
Binary value in bytes. |
InputStream |
Value.getStream()
Deprecated.
As of JCR 2.0,
Value.getBinary() should be used instead. |
InputStream |
Property.getStream()
Deprecated.
As of JCR 2.0,
Property.getBinary() should be used instead. |
InputStream |
Binary.getStream()
Returns an
InputStream representation of this value. |
String |
Value.getString()
Returns a
String representation of this value. |
String |
Property.getString()
Returns a
String representation of the value of this
property. |
int |
Property.getType()
Returns the type of this
Property . |
String |
NamespaceRegistry.getURI(String prefix)
Returns the URI to which the given
prefix is mapped. |
String[] |
NamespaceRegistry.getURIs()
Returns an array holding all currently registered URIs.
|
String |
Node.getUUID()
Deprecated.
As of JCR 2.0,
Node.getIdentifier() should be used
instead. |
Value |
Property.getValue()
Returns the value of this property as a
Value object. |
ValueFactory |
Session.getValueFactory()
This method returns a
ValueFactory that is used to create
Value objects for use when setting repository properties. |
Value[] |
Property.getValues()
Returns an array of all the values of this property.
|
PropertyIterator |
Node.getWeakReferences()
This method returns all
WEAKREFERENCE properties that refer
to this node and that are accessible through the current
Session . |
PropertyIterator |
Node.getWeakReferences(String name)
This method returns all
WEAKREFERENCE properties that refer
to this node, have the specified name and that are
accessible through the current Session . |
VersionHistory |
Node.getVersionHistory()
Deprecated.
As of JCR 2.0,
VersionManager.getVersionHistory(java.lang.String)
should be used instead. |
VersionManager |
Workspace.getVersionManager()
Returns the
VersionManager object. |
boolean |
Session.hasCapability(String methodName,
Object target,
Object[] arguments)
Checks whether an operation can be performed given as much context as can
be determined by the repository, including: Permissions granted
to the current user, including access control privileges.
|
boolean |
Node.hasNode(String relPath)
Indicates whether a node exists at
relPath Returns
true if a node accessible through the current
Session exists at relPath and
false otherwise. |
boolean |
Node.hasNodes()
Indicates whether this node has child nodes.
|
boolean |
Session.hasPendingChanges()
Returns
true if this session holds pending (that is,
unsaved) changes; otherwise returns false . |
boolean |
Session.hasPermission(String absPath,
String actions)
Returns
true if this Session has permission to
perform the specified actions at the specified absPath and
false otherwise. |
boolean |
Node.hasProperties()
Indicates whether this node has properties.
|
boolean |
Node.hasProperty(String relPath)
Indicates whether a property exists at
relPath Returns
true if a property accessible through the current
Session exists at relPath and
false otherwise. |
boolean |
Node.holdsLock()
Deprecated.
As of JCR 2.0,
LockManager.holdsLock(String) should
be used instead. |
Session |
Session.impersonate(Credentials credentials)
Returns a new session in accordance with the specified (new) Credentials.
|
void |
Workspace.importXML(String parentAbsPath,
InputStream in,
int uuidBehavior)
Deserializes an XML document and adds the resulting item subgraph as a
child of the node at
parentAbsPath . |
void |
Session.importXML(String parentAbsPath,
InputStream in,
int uuidBehavior)
Deserializes an XML document and adds the resulting item subgraph as a
child of the node at
parentAbsPath . |
boolean |
Node.isCheckedOut()
Returns
false if this node is currently in the checked-in state
(either due to its own status as a versionable node or due to the effect of
a versionable node being checked in above it). |
boolean |
Node.isLocked()
Returns
true if this node is locked either as a result of a
lock held by this node or by a deep lock on a node above this node;
otherwise returns false . |
boolean |
Property.isMultiple()
Returns
true if this property is multi-valued and
false if this property is single-valued. |
boolean |
Node.isNodeType(String nodeTypeName)
Returns
true if this node is of the specified primary node
type or mixin type, or a subtype thereof. |
boolean |
Item.isSame(Item otherItem)
Returns
true if this Item object (the Java
object instance) represents the same actual workspace item as the object
otherItem . |
boolean |
Session.itemExists(String absPath)
Returns
true if an item exists at absPath and
this Session has read access to it; otherwise returns
false . |
Lock |
Node.lock(boolean isDeep,
boolean isSessionScoped)
Deprecated.
As of JCR 2.0,
LockManager.lock(String, boolean,
boolean, long, String) should be used instead. |
Session |
Repository.login()
Equivalent to
login(null, null) . |
Session |
Repository.login(Credentials credentials)
Equivalent to
login(credentials, null) . |
Session |
Repository.login(Credentials credentials,
String workspaceName)
Authenticates the user using the supplied
credentials . |
Session |
Repository.login(String workspaceName)
Equivalent to
login(null, workspaceName) . |
NodeIterator |
Node.merge(String srcWorkspace,
boolean bestEffort)
Deprecated.
As of JCR 2.0,
VersionManager.merge(java.lang.String, java.lang.String, boolean)
should be used instead. |
void |
Workspace.move(String srcAbsPath,
String destAbsPath)
Moves the node at
srcAbsPath (and its entire subgraph) to
the new location at destAbsPath . |
void |
Session.move(String srcAbsPath,
String destAbsPath)
Moves the node at
srcAbsPath (and its entire subgraph) to
the new location at destAbsPath . |
boolean |
Session.nodeExists(String absPath)
Returns
true if a node exists at absPath and
this Session has read access to it; otherwise returns
false . |
void |
Node.orderBefore(String srcChildRelPath,
String destChildRelPath)
If this node supports child node ordering, this method inserts the child
node at
srcChildRelPath into the child node list at the
position immediately the child node at destChildRelPath . |
boolean |
Session.propertyExists(String absPath)
Returns
true if a property exists at absPath
and this Session has read access to it; otherwise returns
false . |
int |
Binary.read(byte[] b,
long position)
Reads successive bytes from the specified
position in this
Binary into the passed byte array until either the byte
array is full or the end of the Binary is encountered. |
void |
Item.refresh(boolean keepChanges)
If
keepChanges is false , this method discards
all pending changes currently recorded in this Session that
apply to this Item or any of its descendants (that is, the subgraph
rooted at this Item)and returns all items to reflect the current saved
state. |
void |
Session.refresh(boolean keepChanges)
If
keepChanges is false , this method discards
all pending changes currently recorded in this Session and
returns all items to reflect the current saved state. |
void |
NamespaceRegistry.registerNamespace(String prefix,
String uri)
Sets a one-to-one mapping between
prefix and
uri in the global namespace registry of this repository. |
void |
Item.remove()
Removes
this item (and its subgraph). |
void |
Session.removeItem(String absPath)
Removes the specified item and its subgraph.
|
void |
Node.removeMixin(String mixinName)
Removes the specified mixin node type from this node and removes
mixinName from this node's jcr:mixinTypes
property. |
void |
Node.removeShare()
Removes this node, but does not remove any other node in the shared set
of this node.
|
void |
Node.removeSharedSet()
Removes this node and every other node in the shared set of this node.
|
void |
Node.restore(String versionName,
boolean removeExisting)
Deprecated.
As of JCR 2.0,
VersionManager.restore(javax.jcr.version.Version[], boolean)
should be used instead. |
void |
Workspace.restore(Version[] versions,
boolean removeExisting)
Deprecated.
As of JCR 2.0,
VersionManager.restore(javax.jcr.version.Version[], boolean)
should be used instead. |
void |
Node.restore(Version version,
boolean removeExisting)
Deprecated.
As of JCR 2.0,
VersionManager.restore(javax.jcr.version.Version[], boolean)
should be used instead. |
void |
Node.restore(Version version,
String relPath,
boolean removeExisting)
Deprecated.
As of JCR 2.0,
VersionManager.restore(javax.jcr.version.Version[], boolean)
should be used instead. |
void |
Node.restoreByLabel(String versionLabel,
boolean removeExisting)
Deprecated.
As of JCR 2.0,
VersionManager.restoreByLabel(java.lang.String, java.lang.String, boolean)
should be used instead. |
void |
Item.save()
Validates all pending changes currently recorded in this
Session that apply to this Item or any of its
descendants (that is, the subgraph rooted at this Item). |
void |
Session.save()
Validates all pending changes currently recorded in this
Session . |
void |
Session.setNamespacePrefix(String prefix,
String uri)
Within the scope of this
Session , this method maps
uri to prefix . |
void |
Node.setPrimaryType(String nodeTypeName)
Changes the primary node type of this node to
nodeTypeName . |
Property |
Node.setProperty(String name,
BigDecimal value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a BigDecimal and, if possible, the type assigned to
the property is DECIMAL , otherwise a best-effort conversion
is attempted. |
Property |
Node.setProperty(String name,
Binary value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a Binary and, if possible, the type assigned to the
property is BINARY , otherwise a best-effort conversion is
attempted. |
Property |
Node.setProperty(String name,
boolean value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a boolean and, if possible, the type assigned
to the property is BOOLEAN , otherwise a best-effort
conversion is attempted. |
Property |
Node.setProperty(String name,
Calendar value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a Calendar and, if possible, the type assigned to
the property is DATE , otherwise a best-effort conversion is
attempted. |
Property |
Node.setProperty(String name,
double value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a double and, if possible, the type assigned to
the property is DOUBLE , otherwise a best-effort conversion
is attempted. |
Property |
Node.setProperty(String name,
InputStream value)
Deprecated.
As of JCR 2.0,
Node.setProperty(String, Binary) should be
used instead. |
Property |
Node.setProperty(String name,
long value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a long and, if possible, the type assigned to
the property is LONG , otherwise a best-effort conversion is
attempted. |
Property |
Node.setProperty(String name,
Node value)
The behavior of this method is identical to that of
Node.setProperty(String name, Value value) except that the value is
specified as a Node and, if possible, the type assigned to the
property is REFERENCE or WEAKREFERENCE ,
otherwise a best-effort conversion is attempted. |
Property |
Node.setProperty(String name,
String value)
Sets the specified single-value property to the specified value.
|
Property |
Node.setProperty(String name,
String[] values)
Sets the specified property to the specified array of values.
|
Property |
Node.setProperty(String name,
String[] values,
int type)
Sets the specified property to the specified array of values and to the
specified type.
|
Property |
Node.setProperty(String name,
String value,
int type)
Sets the specified single-value property to the specified value.
|
Property |
Node.setProperty(String name,
Value value)
Sets the single-value property of this node called
name to
the specified value . |
Property |
Node.setProperty(String name,
Value[] values)
Sets the multi-value property of this node called
name to
the specified array of values. |
Property |
Node.setProperty(String name,
Value[] values,
int type)
Sets the multi-value property of this node called
name to
the specified array of values. |
Property |
Node.setProperty(String name,
Value value,
int type)
Sets the single-value property of this node called
name to
the specified value and the specified type . |
void |
Property.setValue(BigDecimal value)
Sets the value of this property to
value . |
void |
Property.setValue(Binary value)
Sets the value of this property to
value . |
void |
Property.setValue(boolean value)
Sets the value of this property to
value . |
void |
Property.setValue(Calendar value)
Sets the value of this property to
value . |
void |
Property.setValue(double value)
Sets the value of this property to
value . |
void |
Property.setValue(InputStream value)
Deprecated.
As of JCR 2.0,
Property.setValue(Binary) should be used
instead. |
void |
Property.setValue(long value)
Sets the value of this property to
value . |
void |
Property.setValue(Node value)
Sets this
REFERENCE or WEAKREFERNCE property to
refer to the specified node. |
void |
Property.setValue(String value)
Sets the value of this property to
value . |
void |
Property.setValue(String[] values)
Sets the value of this property to the
values array. |
void |
Property.setValue(Value value)
Sets the value of this property to
value . |
void |
Property.setValue(Value[] values)
Sets the value of this property to the
values array. |
void |
Node.unlock()
Deprecated.
As of JCR 2.0,
LockManager.unlock(String) should be
used instead. |
void |
NamespaceRegistry.unregisterNamespace(String prefix)
Removes a namespace mapping from the registry.
|
void |
Node.update(String srcWorkspace)
If this node does have a corresponding node in the workspace
srcWorkspace , then this replaces this node and its subgraph
with a clone of the corresponding node and its subgraph. |
void |
ItemVisitor.visit(Node node)
This method is called when the
ItemVisitor is passed to the
accept method of a Node . |
void |
ItemVisitor.visit(Property property)
This method is called when the
ItemVisitor is passed to the
accept method of a Property . |
Modifier and Type | Class and Description |
---|---|
class |
LockException
Exception thrown by when a lock-related error occurs.
|
Modifier and Type | Method and Description |
---|---|
void |
LockManager.addLockToken(String lockToken)
Adds the specified lock token to the current
Session . |
Lock |
LockManager.getLock(String absPath)
Returns the
Lock object that applies to the node at the
specified absPath . |
String[] |
LockManager.getLockTokens()
Returns an array containing all lock tokens currently held by the current
Session . |
long |
Lock.getSecondsRemaining()
Returns the number of seconds remaining until this locks times out.
|
boolean |
LockManager.holdsLock(String absPath)
Returns
true if the node at absPath holds a
lock; otherwise returns false . |
boolean |
Lock.isLive()
Returns true if this
Lock object represents a lock that is
currently in effect. |
boolean |
LockManager.isLocked(String absPath)
Returns
true if the node at absPath is locked
either as a result of a lock held by that node or by a deep lock on a
node above that node; otherwise returns false . |
Lock |
LockManager.lock(String absPath,
boolean isDeep,
boolean isSessionScoped,
long timeoutHint,
String ownerInfo)
Places a lock on the node at
absPath . |
void |
Lock.refresh()
If this lock's time-to-live is governed by a timer, this method resets
that timer so that the lock does not timeout and expire.
|
void |
LockManager.removeLockToken(String lockToken)
Removes the specified lock token from this
Session . |
void |
LockManager.unlock(String absPath)
Removes the lock on the node at
absPath . |
Modifier and Type | Class and Description |
---|---|
class |
ConstraintViolationException
Exception thrown when an action would violate a constraint on repository
structure.
|
class |
InvalidNodeTypeDefinitionException
Exception thrown when an attempt is made to register an invalid node type
definition template.
|
class |
NodeTypeExistsException
Exception thrown when an attempt is made to register a node type that already
exists, and
allowUpdate has not been set to true . |
class |
NoSuchNodeTypeException
Exception thrown by node type-related methods.
|
Modifier and Type | Method and Description |
---|---|
NodeDefinitionTemplate |
NodeTypeManager.createNodeDefinitionTemplate()
Returns an empty
NodeDefinitionTemplate which can then be
used to create a child node definition and attached to a
NodeTypeTemplate . |
NodeTypeTemplate |
NodeTypeManager.createNodeTypeTemplate()
Returns an empty
NodeTypeTemplate which can then be used to
define a node type and passed to NodeTypeManager.registerNodeType . |
NodeTypeTemplate |
NodeTypeManager.createNodeTypeTemplate(NodeTypeDefinition ntd)
Returns a
NodeTypeTemplate holding the specified node type
definition. |
PropertyDefinitionTemplate |
NodeTypeManager.createPropertyDefinitionTemplate()
Returns an empty
PropertyDefinitionTemplate which can then
be used to create a property definition and attached to a
NodeTypeTemplate . |
NodeTypeIterator |
NodeTypeManager.getAllNodeTypes()
Returns an iterator over all available node types (primary and mixin).
|
NodeTypeIterator |
NodeTypeManager.getMixinNodeTypes()
Returns an iterator over all available mixin node types.
|
NodeType |
NodeTypeManager.getNodeType(String nodeTypeName)
Returns the named node type.
|
NodeTypeIterator |
NodeTypeManager.getPrimaryNodeTypes()
Returns an iterator over all available primary node types.
|
boolean |
NodeTypeManager.hasNodeType(String name)
Returns
true if a node type with the specified name is
registered. |
NodeType |
NodeTypeManager.registerNodeType(NodeTypeDefinition ntd,
boolean allowUpdate)
Registers a new node type or updates an existing node type using the
specified definition and returns the resulting
NodeType
object. |
NodeTypeIterator |
NodeTypeManager.registerNodeTypes(NodeTypeDefinition[] ntds,
boolean allowUpdate)
Registers or updates the specified array of
NodeTypeDefinition
objects. |
void |
NodeTypeManager.unregisterNodeType(String name)
Unregisters the specified node type.
|
void |
NodeTypeManager.unregisterNodeTypes(String[] names)
Unregisters the specified set of node types.
|
Modifier and Type | Method and Description |
---|---|
void |
ObservationManager.addEventListener(EventListener listener,
int eventTypes,
String absPath,
boolean isDeep,
String[] uuid,
String[] nodeTypeName,
boolean noLocal)
Adds an event listener that listens for the specified
eventTypes (a combination of one or more event types encoded
as a bit mask value). |
long |
Event.getDate()
Returns the date when the change was persisted that caused this event.
|
EventJournal |
ObservationManager.getEventJournal()
Retrieves the event journal for this workspace.
|
EventJournal |
ObservationManager.getEventJournal(int eventTypes,
String absPath,
boolean isDeep,
String[] uuid,
String[] nodeTypeName)
Retrieves the event journal for this workspace.
|
String |
Event.getIdentifier()
Returns the identifier associated with this event or
null if
this event has no associated identifier. |
Map |
Event.getInfo()
Returns the information map associated with this event.
|
String |
Event.getPath()
Returns the absolute path associated with this event or
null
if this event has no associated identifier. |
EventListenerIterator |
ObservationManager.getRegisteredEventListeners()
Returns all event listeners that have been registered through this
session.
|
String |
Event.getUserData()
Returns the user data set through
ObservationManager.setUserData(java.lang.String)
on the ObservationManager bound to the Session
that caused the event. |
void |
ObservationManager.removeEventListener(EventListener listener)
Deregisters an event listener.
|
void |
ObservationManager.setUserData(String userData)
Sets the user data information that will be returned by
Event.getUserData() . |
Modifier and Type | Class and Description |
---|---|
class |
InvalidQueryException
Thrown by methods of
Query . |
Modifier and Type | Method and Description |
---|---|
void |
Query.bindValue(String varName,
Value value)
Binds the given
value to the variable named
varName . |
Query |
QueryManager.createQuery(String statement,
String language)
Creates a new query by specifying the query
statement itself
and the language in which the query is stated. |
QueryResult |
Query.execute()
Executes this query and returns a
object. |
String[] |
Query.getBindVariableNames()
Returns the names of the bind variables in this query.
|
String[] |
QueryResult.getColumnNames()
Returns an array of all the column names in the table view of this result
set.
|
Node |
Row.getNode()
Returns the
Node corresponding to this Row . |
Node |
Row.getNode(String selectorName)
Returns the
Node corresponding to this Row and
the specified selector. |
NodeIterator |
QueryResult.getNodes()
Returns an iterator over all nodes that match the query.
|
String |
Row.getPath()
Equivalent to
Row.getNode().getPath() . |
String |
Row.getPath(String selectorName)
Equivalent to
Row.getNode(selectorName).getPath() . |
Query |
QueryManager.getQuery(Node node)
Retrieves an existing persistent query.
|
RowIterator |
QueryResult.getRows()
Returns an iterator over the
Row s of the result table. |
double |
Row.getScore()
Returns the full text search score for this row associated with the
default selector.
|
double |
Row.getScore(String selectorName)
Returns the full text search score for this row associated with the
specified selector.
|
String[] |
QueryResult.getSelectorNames()
Returns an array of all the selector names that were used in the query
that created this result.
|
String |
Query.getStoredQueryPath()
If this is a
Query object that has been stored using Query.storeAsNode(java.lang.String) (regardless of whether it has been save d
yet) or retrieved using QueryManager.getQuery(javax.jcr.Node) ), then this method
returns the path of the nt:query node that stores the
query. |
String[] |
QueryManager.getSupportedQueryLanguages()
Returns an array of strings representing all query languages supported by
this repository.
|
Value |
Row.getValue(String columnName)
Returns the value of the indicated column in this
Row . |
Value[] |
Row.getValues()
Returns an array of all the values in the same order as the column names
returned by
QueryResult.getColumnNames() . |
Node |
Query.storeAsNode(String absPath)
Creates a node of type
nt:query holding this query at
absPath and returns that node. |
Modifier and Type | Method and Description |
---|---|
And |
QueryObjectModelFactory.and(Constraint constraint1,
Constraint constraint2)
Performs a logical conjunction of two other constraints.
|
Ordering |
QueryObjectModelFactory.ascending(DynamicOperand operand)
Orders by the value of the specified operand, in ascending order.
|
BindVariableValue |
QueryObjectModelFactory.bindVariable(String bindVariableName)
Evaluates to the value of a bind variable.
|
ChildNode |
QueryObjectModelFactory.childNode(String selectorName,
String path)
Tests whether a node in the specified selector is a child of a node
reachable by a specified absolute path.
|
ChildNodeJoinCondition |
QueryObjectModelFactory.childNodeJoinCondition(String childSelectorName,
String parentSelectorName)
Tests whether a first selector's node is a child of a second selector's
node.
|
Column |
QueryObjectModelFactory.column(String selectorName,
String propertyName,
String columnName)
Identifies a property in the specified selector to include in the tabular
view of query results.
|
Comparison |
QueryObjectModelFactory.comparison(DynamicOperand operand1,
String operator,
StaticOperand operand2)
Filters node-tuples based on the outcome of a binary operation.
|
QueryObjectModel |
QueryObjectModelFactory.createQuery(Source source,
Constraint constraint,
Ordering[] orderings,
Column[] columns)
Creates a query with one or more selectors.
|
DescendantNode |
QueryObjectModelFactory.descendantNode(String selectorName,
String path)
Tests whether a node in the specified selector is a descendant of a node
reachable by a specified absolute path.
|
DescendantNodeJoinCondition |
QueryObjectModelFactory.descendantNodeJoinCondition(String descendantSelectorName,
String ancestorSelectorName)
Tests whether a first selector's node is a descendant of a second
selector's node.
|
Ordering |
QueryObjectModelFactory.descending(DynamicOperand operand)
Orders by the value of the specified operand, in descending order.
|
EquiJoinCondition |
QueryObjectModelFactory.equiJoinCondition(String selector1Name,
String property1Name,
String selector2Name,
String property2Name)
Tests whether the value of a property in a first selector is equal to the
value of a property in a second selector.
|
FullTextSearch |
QueryObjectModelFactory.fullTextSearch(String selectorName,
String propertyName,
StaticOperand fullTextSearchExpression)
Performs a full-text search against the specified selector.
|
FullTextSearchScore |
QueryObjectModelFactory.fullTextSearchScore(String selectorName)
Evaluates to a
DOUBLE value equal to the full-text search
score of a node in the specified selector. |
Join |
QueryObjectModelFactory.join(Source left,
Source right,
String joinType,
JoinCondition joinCondition)
Performs a join between two node-tuple sources.
|
Length |
QueryObjectModelFactory.length(PropertyValue propertyValue)
Evaluates to the length (or lengths, if multi-valued) of a property.
|
Literal |
QueryObjectModelFactory.literal(Value literalValue)
Evaluates to a literal value.
|
LowerCase |
QueryObjectModelFactory.lowerCase(DynamicOperand operand)
Evaluates to the lower-case string value (or values, if multi-valued) of
an operand.
|
NodeLocalName |
QueryObjectModelFactory.nodeLocalName(String selectorName)
Evaluates to a
NAME value equal to the local (unprefixed)
name of a node in the specified selector. |
NodeName |
QueryObjectModelFactory.nodeName(String selectorName)
Evaluates to a
NAME value equal to the prefix-qualified name
of a node in the specified selector. |
Not |
QueryObjectModelFactory.not(Constraint constraint)
Performs a logical negation of another constraint.
|
Or |
QueryObjectModelFactory.or(Constraint constraint1,
Constraint constraint2)
Performs a logical disjunction of two other constraints.
|
PropertyExistence |
QueryObjectModelFactory.propertyExistence(String selectorName,
String propertyName)
Tests the existence of a property in the specified selector.
|
PropertyValue |
QueryObjectModelFactory.propertyValue(String selectorName,
String propertyName)
Evaluates to the value (or values, if multi-valued) of a property in the
specified selector.
|
SameNode |
QueryObjectModelFactory.sameNode(String selectorName,
String path)
Tests whether a node in the specified selector is reachable by a
specified absolute path.
|
SameNodeJoinCondition |
QueryObjectModelFactory.sameNodeJoinCondition(String selector1Name,
String selector2Name,
String selector2Path)
Tests whether a first selector's node is the same as a node identified by
relative path from a second selector's node.
|
Selector |
QueryObjectModelFactory.selector(String nodeTypeName,
String selectorName)
Selects a subset of the nodes in the repository based on node type.
|
UpperCase |
QueryObjectModelFactory.upperCase(DynamicOperand operand)
Evaluates to the upper-case string value (or values, if multi-valued) of
an operand.
|
Modifier and Type | Method and Description |
---|---|
Hold |
RetentionManager.addHold(String absPath,
String name,
boolean isDeep)
Places a hold on the existing node at
absPath . |
Hold[] |
RetentionManager.getHolds(String absPath)
Returns all hold objects that have been added through this API to the
existing node at
absPath . |
String |
RetentionPolicy.getName()
Returns the name of the retention policy.
|
String |
Hold.getName()
Returns the name of this
Hold . |
RetentionPolicy |
RetentionManager.getRetentionPolicy(String absPath)
Returns the retention policy that has been set using
RetentionManager.setRetentionPolicy(java.lang.String, javax.jcr.retention.RetentionPolicy) on the node at absPath or
null if no policy has been set. |
boolean |
Hold.isDeep()
Returns
true if this Hold is deep. |
void |
RetentionManager.removeHold(String absPath,
Hold hold)
Removes the specified
hold from the node at
absPath . |
void |
RetentionManager.removeRetentionPolicy(String absPath)
Causes the current retention policy on the node at
absPath
to no longer apply. |
void |
RetentionManager.setRetentionPolicy(String absPath,
RetentionPolicy retentionPolicy)
Sets the retention policy of the node at
absPath to that
defined in the specified policy node. |
Modifier and Type | Class and Description |
---|---|
class |
AccessControlException
Exception thrown by access control related methods of
AccessControlManager . |
Modifier and Type | Method and Description |
---|---|
boolean |
AccessControlList.addAccessControlEntry(Principal principal,
Privilege[] privileges)
Adds an access control entry to this policy consisting of the specified
principal and the specified privileges . |
AccessControlEntry[] |
AccessControlList.getAccessControlEntries()
Returns all access control entries present with this policy.
|
AccessControlPolicyIterator |
AccessControlManager.getApplicablePolicies(String absPath)
Returns the access control policies that are capable of being applied to
the node at
absPath . |
AccessControlPolicy[] |
AccessControlManager.getEffectivePolicies(String absPath)
Returns the
AccessControlPolicy objects that currently are
in effect at the node at absPath . |
String |
NamedAccessControlPolicy.getName()
Returns the name of the access control policy, which is JCR name and
should be unique among the choices applicable to any particular node.
|
AccessControlPolicy[] |
AccessControlManager.getPolicies(String absPath)
Returns the
AccessControlPolicy objects that have been set
to the node at absPath or an empty array if no policy has
been set. |
Privilege[] |
AccessControlManager.getPrivileges(String absPath)
Returns the privileges the session has for absolute path absPath, which
must be an existing node.
|
Privilege[] |
AccessControlManager.getSupportedPrivileges(String absPath)
Returns the privileges supported for absolute path
absPath ,
which must be an existing node. |
boolean |
AccessControlManager.hasPrivileges(String absPath,
Privilege[] privileges)
Returns whether the session has the specified privileges for absolute
path
absPath , which must be an existing node. |
Privilege |
AccessControlManager.privilegeFromName(String privilegeName)
Returns the privilege with the specified
privilegeName . |
void |
AccessControlList.removeAccessControlEntry(AccessControlEntry ace)
Removes the specified
AccessControlEntry from this policy. |
void |
AccessControlManager.removePolicy(String absPath,
AccessControlPolicy policy)
Removes the specified
AccessControlPolicy from the node at
absPath . |
void |
AccessControlManager.setPolicy(String absPath,
AccessControlPolicy policy)
Binds the
policy to the node at absPath . |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
TraversingItemVisitor.entering(Node node,
int level)
Implement this method to add behavior performed before a
Node is visited. |
protected void |
TraversingItemVisitor.Default.entering(Node node,
int level) |
protected abstract void |
TraversingItemVisitor.entering(Property property,
int level)
Implement this method to add behavior performed before a
Property is visited. |
protected void |
TraversingItemVisitor.Default.entering(Property property,
int level) |
protected abstract void |
TraversingItemVisitor.leaving(Node node,
int level)
Implement this method to add behavior performed after a
Node
is visited. |
protected void |
TraversingItemVisitor.Default.leaving(Node node,
int level) |
protected abstract void |
TraversingItemVisitor.leaving(Property property,
int level)
Implement this method to add behavior performed after a
Property is visited. |
protected void |
TraversingItemVisitor.Default.leaving(Property property,
int level) |
void |
TraversingItemVisitor.visit(Node node)
Called when the
Visitor is passed to a Node . |
void |
TraversingItemVisitor.visit(Property property)
Called when the
Visitor is passed to a
Property . |
Modifier and Type | Class and Description |
---|---|
class |
ActivityViolationException
Exception will be thrown by
Node.checkout and
Node.checkpoint if an activity A is present on the current
session and any of the following conditions is met: There already is
a node in another workspace that has a checked-out node for the version
history of N whose jcr:activity references A. |
class |
LabelExistsVersionException
Exception thrown by
VersionHistory.addVersionLabel if
moveLabel is set to false and an attempt is made to
add a label that already exists in the VersionHistory . |
class |
VersionException
Exception thrown by Version.addSuccessor if an invalid version graph
operation is attempted.
|
Modifier and Type | Method and Description |
---|---|
void |
VersionHistory.addVersionLabel(String versionName,
String label,
boolean moveLabel)
Adds the specified label to the specified version.
|
void |
VersionManager.cancelMerge(String absPath,
Version version)
Cancels the merge process with respect to the node at
absPath and the specified version . |
Version |
VersionManager.checkin(String absPath)
Creates for the versionable node at
absPath a new version
with a system generated version name and returns that version (which will
be the new base version of this node). |
void |
VersionManager.checkout(String absPath)
Sets the versionable node at
absPath to checked-out status
by setting its jcr:isCheckedOut property to
true . |
Version |
VersionManager.checkpoint(String absPath)
Performs a
checkin() followed by a checkout()
on the versionable node at absPath . |
Node |
VersionManager.createActivity(String title)
This method creates a new
nt:activity at an
implementation-determined location in the /jcr:system/jcr:activities
subgraph. |
Node |
VersionManager.createConfiguration(String absPath)
Calling
createConfiguration on the node N at
absPath creates, in the configuration storage, a new
nt:configuration node whose root is N. |
void |
VersionManager.doneMerge(String absPath,
Version version)
Completes the merge process with respect to the node at
absPath and the specified version . |
Node |
VersionManager.getActivity()
Returns the node representing the current activity or
null
if there is no current activity. |
NodeIterator |
VersionHistory.getAllFrozenNodes()
Returns an iterator over all the frozen nodes of all the versions of this
version history.
|
NodeIterator |
VersionHistory.getAllLinearFrozenNodes()
This method returns all the frozen nodes of all the versions in this
version history in the same order as
VersionHistory.getAllLinearVersions() . |
VersionIterator |
VersionHistory.getAllLinearVersions()
This method returns an iterator over all the versions in the line of
descent from the root version to that base version within this
history that is bound to the workspace through which this
VersionHistory was accessed. |
VersionIterator |
VersionHistory.getAllVersions()
Returns an iterator over all the versions within this version history.
|
Version |
VersionManager.getBaseVersion(String absPath)
Returns the current base version of the versionable node at
absPath . |
VersionHistory |
Version.getContainingHistory()
Returns the
VersionHistory that contains this
Version . |
Calendar |
Version.getCreated()
Returns the date this version was created.
|
Node |
Version.getFrozenNode()
Returns the frozen node of this version.
|
Version |
Version.getLinearPredecessor()
Assuming that this
Version object was acquired through a
Workspace W and is within the
VersionHistory H , this method returns the
predecessor of this version along the same line of descent as is returned
by H.getAllLinearVersions() where H was also
acquired through W . |
Version |
Version.getLinearSuccessor()
Assuming that this
Version object was acquired through a
Workspace W and is within the
VersionHistory H , this method returns the
successor of this version along the same line of descent as is returned
by H.getAllLinearVersions() where H was also
acquired through W . |
Version[] |
Version.getPredecessors()
In both simple and full versioning repositories, this method returns the
predecessor versions of this version.
|
Version |
VersionHistory.getRootVersion()
Returns the root version of this version history.
|
Version[] |
Version.getSuccessors()
Returns the successor versions of this version.
|
Version |
VersionHistory.getVersion(String versionName)
Retrieves a particular version from this version history by version
name.
|
String |
VersionHistory.getVersionableIdentifier()
Returns the identifier of the versionable node for which this is the
version history.
|
String |
VersionHistory.getVersionableUUID()
Deprecated.
As of JCR 2.0,
VersionHistory.getVersionableIdentifier() should be
used instead. |
Version |
VersionHistory.getVersionByLabel(String label)
Retrieves a particular version from this version history by version
label.
|
VersionHistory |
VersionManager.getVersionHistory(String absPath)
Returns the
VersionHistory object of the node at
absPath . |
String[] |
VersionHistory.getVersionLabels()
Returns all version labels of the history or an empty array if there are
none.
|
String[] |
VersionHistory.getVersionLabels(Version version)
Returns all version labels of the given
version - empty
array if none. |
boolean |
VersionHistory.hasVersionLabel(String label)
Returns
true if any version in the history has the given
label . |
boolean |
VersionHistory.hasVersionLabel(Version version,
String label)
Returns true if the given version has the given
label . |
boolean |
VersionManager.isCheckedOut(String absPath)
Returns
true if the node at absPath is either
versionable (full or simple) and currently checked-out,
non-versionable and its nearest versionable ancestor is checked-out
or non-versionable and it has no versionable ancestor. |
NodeIterator |
VersionManager.merge(Node activityNode)
This method merges the changes that were made under the specified
activity into the current workspace.
|
NodeIterator |
VersionManager.merge(String absPath,
String srcWorkspace,
boolean bestEffort)
This method recursively tests each versionable node in the subgraph of
the node at
absPath against its corresponding node in
srcWorkspace with respect to the relation between their
respective base versions and either updates the node in question or not,
depending on the outcome of the test. |
NodeIterator |
VersionManager.merge(String absPath,
String srcWorkspace,
boolean bestEffort,
boolean isShallow)
Same as
VersionManager.merge(String absPath, String srcWorkspace, boolean
bestEffort) except that an option exists to make the merge
shallow. |
void |
VersionManager.removeActivity(Node activityNode)
This method removes the given
activityNode and all REFERENCE properties
within all workspaces that refer to the activityNode . |
void |
VersionHistory.removeVersion(String versionName)
Removes the named version from this version history and automatically
repairs the version graph.
|
void |
VersionHistory.removeVersionLabel(String label)
Removes the specified label from among the labels of this version
history.
|
void |
VersionManager.restore(String absPath,
String versionName,
boolean removeExisting)
Restores the node at
absPath to the state defined by the
version with the specified versionName . |
void |
VersionManager.restore(String absPath,
Version version,
boolean removeExisting)
Restores the specified version to
absPath . |
void |
VersionManager.restore(Version[] versions,
boolean removeExisting)
Restores a set of versions at once.
|
void |
VersionManager.restore(Version version,
boolean removeExisting)
Restores the node in the current workspace that is the versionable node of the
specified
version to the state reflected in that version. |
void |
VersionManager.restoreByLabel(String absPath,
String versionLabel,
boolean removeExisting)
Restores the version of the node at
absPath with the
specified version label. |
Node |
VersionManager.setActivity(Node activity)
This method is called by the client to set the current activity on the
current session by specifying a previously created
nt:activity
node (see VersionManager.createActivity(java.lang.String) ). |
Modifier and Type | Method and Description |
---|---|
boolean |
CollaborationGroupFolderUtil.containsCollaborationGroup(Node aCollaborationGroupFolder,
String aGroupName)
Whether or not a collaboration group folder already contains a named collaboration group.
|
Node |
CollaborationGroupUtil.createCollaborationGroup(Node aGroupTemplate,
Node aGroupFolder,
String aGroupName)
Creates an open collaboration group.
|
Node |
CollaborationGroupUtil.createCollaborationGroup(Node aGroupTemplate,
Node aGroupFolder,
String aGroupName,
CollaborationGroupType aGroupType)
Creates a collaboration group.
|
Modifier and Type | Method and Description |
---|---|
void |
MetadataDefinitionUtil.addAlternative(Node aNode,
String aDefinitionName,
String aAlternativeName)
Add an alternative to a definition
|
Node |
MetadataUtil.getLinkMetadataPropertyValue(Node aNode,
String aPropertyName)
Returns a
Node for a link metadata on a specified Node . |
List |
MetadataUtil.getRelatedMetadataPropertyValues(Node aNode,
String aPropertyName)
Returns a
List containing all related metadata values for a specified Node . |
boolean |
MetadataUtil.isMetadataValueInherited(Node aNode,
Property aProperty)
Returns a
boolean indicating that the metadata value on the Node is
inherited from a parent node. |
boolean |
MetadataUtil.isMetadataValueInherited(Node aNode,
Property aProperty,
int aVersion)
Returns a
boolean indicating that the metadata value in a specified version on the Node is
inherited from a parent node. |
boolean |
MetadataUtil.isMetadataValueInherited(Node aNode,
String aPropertyName)
Returns a
boolean indicating that the metadata value on the Node is
inherited from a parent node. |
boolean |
MetadataUtil.isMetadataValueInherited(Node aNode,
String aPropertyName,
int aVersion)
Returns a
boolean indicating that the metadata value in a specified version on the Node is
inherited from a parent node. |
void |
MetadataDefinitionUtil.removeAlternative(Node aNode,
String aDefinitionName,
String aAlternativeName)
Remove an alternative from a definition
|
void |
MetadataUtil.removeMetadataPropertyValue(Node aNode,
Property aProperty)
Removes a metadata
Property value on a Node . |
void |
MetadataUtil.removeMetadataPropertyValue(Node aNode,
String aPropertyName)
Removes a metadata
Property value on a Node . |
void |
MetadataDefinitionUtil.renameAlternative(Node aNode,
String aDefinitionName,
String aAlternativeName,
String aNewAlternativeName)
Rename an alternative for a definition
|
void |
MetadataUtil.setMetadataPropertyValue(Node aNode,
Property aProperty,
Object aValue)
Set a new value to a metadata
Property on a Node . |
void |
MetadataUtil.setMetadataPropertyValue(Node aNode,
String aPropertyName,
Object aValue)
Set a new value to a metadata
Property on a Node . |
Modifier and Type | Method and Description |
---|---|
void |
RedirectUtil.addRedirectURI(Node aNode,
String aRelativeURI)
Adds a relative URI that should trigger a 301 redirect to a specific node.
|
void |
RedirectUtil.addRedirectURIs(Node aNode,
Collection<String> aRelativeURIs)
Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
|
void |
RedirectUtil.removeAllRedirectURIs(Node aNode)
Removes all relative 301 redirect URIs from a specific node.
|
void |
RedirectUtil.removeRedirectURI(Node aNode,
String aRelativeURI)
Removes a relative 301 redirect URI from a specific node.
|
Modifier and Type | Method and Description |
---|---|
String |
OutputUtil.getNodeInfoAsHTML(Node aNode)
Debug method that returns info about the properties of a node and all its sub nodes.
|
String |
OutputUtil.getNodeInfoAsHTML(Node aNode,
int aDepth)
Debug method that returns info about the properties of a node and all its sub nodes recursively until a given sub level
aDepth is reached. |
Modifier and Type | Method and Description |
---|---|
String |
XSLTUtil.transform(String aSource,
Object aXslTemplate)
Transforms a HTML/XML source using a XSL template.
|
Modifier and Type | Method and Description |
---|---|
void |
RoleAssignment.apply(Node aNode)
Applies this role assignment on a given node.
|
void |
RoleAssignment.revoke(Node aNode)
Revokes this role assignment on a given node.
|
Modifier and Type | Method and Description |
---|---|
void |
SubscriptionUtil.activateSubscription(Node aNode,
boolean subtreeScope,
String title,
String description)
Activates a subscription for the given
Node . |
void |
SubscriptionUtil.configureSubscriptionEmail(Node aNode,
String from,
String fromAddress,
String subject,
String footer)
Configures email properties for the subscription on the given node.
|
void |
SubscriptionUtil.deactivateSubscription(Node aNode)
Deactivates the subscription for the given
Node . |
Modifier and Type | Method and Description |
---|---|
void |
TagUtil.addTag(Node aTaggableNode,
Node aTagNode)
Adds a sv:tag to a Node.
|
void |
TagUtil.addTags(Node aTaggableNode,
Node... aTagNodes)
Adds multiple sv:tag to a Node.
|
Node |
TagUtil.getOrCreateTagByName(String aTagName)
Gets or creates a sv:tag Node by name.
|
boolean |
TagUtil.removeTag(Node aTaggableNode,
Node aTagNode)
Removes a sv:tag from a Node.
|
Modifier and Type | Method and Description |
---|---|
Node |
ArticleUtil.createArticle(Node aParent,
Node aTemplate,
String aName)
Creates an article as sub node to a specified parent.
|
Node |
ArticleUtil.createArticle(Node aParent,
Node aTemplate,
String aName,
Map<String,Object> properties,
Map<String,String> content)
Creates an article with properties and web content.
|
Node |
FileUtil.createFile(Node aParent,
String aFileName,
String aUri)
Creates a file using a uri string.
|
Node |
FileUtil.createFileFromBase64(Node aParent,
String aFileName,
String aBase64EncodedString)
Creates a file using a base64 string.
|
Node |
FileUtil.createFileFromTemporary(Node aParent,
Node aTemporaryFile)
Creates a file using a sv:temporaryFile.
|
void |
FileUtil.createFiles(Node aParent,
Map<String,String> aFileMappings)
Adds several files to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder
residing as sub node to a file repository.
|
Node |
ImageUtil.createImage(Node aParent,
String aFileName,
String aUri)
Creates an image using a uri string.
|
Node |
ImageUtil.createImageFromBase64(Node aParent,
String aFileName,
String aBase64EncodedString)
Creates an image using a base64 string.
|
Node |
ImageUtil.createImageFromTemporary(Node aParent,
Node aTemporaryFile)
Creates an image using a sv:temporaryFile.
|
void |
ImageUtil.createImages(Node aParent,
Map<String,String> aImages)
Adds several images to a
sv:localImageRepository , sv:imageRepository , sv:personalImageRepository
or a sv:folder residing as sub node to an image repository. |
Node |
LinkPageUtil.createLinkPage(Node aParent,
String aName,
LinkTarget aLinkTarget)
Creates a link page as sub node of a specified parent.
|
Node |
LinkPageUtil.createLinkPage(Node aParent,
String aName,
LinkTarget aLinkTarget,
Map<String,Object> aProperties)
Creates a link page with properties as sub node of a specified parent.
|
Node |
PageUtil.createPage(Node aParent,
Node aTemplate,
String aName)
Creates a page as sub node to the specified parent.
|
Node |
PageUtil.createPage(Node aParent,
Node aTemplate,
String aName,
Map<String,Object> properties,
Map<String,String> content)
Creates a page with properties and web content.
|
void |
ArticleUtil.renameArticle(Node anArticle,
String aName)
Alters the name of an article.
|
void |
FileUtil.renameFile(Node aFile,
String aNewName)
Alters the name of a file.
|
void |
ImageUtil.renameImage(Node aImage,
String aName)
Alters the name of an image.
|
void |
LinkPageUtil.renameLinkPage(Node aLinkPage,
String aName)
Updates the name of a link page.
|
void |
PageUtil.renamePage(Node aPage,
String aName)
Alters the name of a page.
|
void |
FileUtil.setDownloadProtected(Node aFile,
boolean aDownloadProtected)
Modifies download protection for a file.
|
void |
FileUtil.setVersioned(Node aFile,
boolean aVersioned)
Modifies versioning for a file.
|
String |
ImageUtil.toBase64(Node aImage)
The Base64 String representation of an image Node.
|
void |
ArticleUtil.updateArticle(Node anArticle,
Map<String,Object> properties)
Updates the properties of an article.
|
void |
ImageUtil.updateBinaryContent(Node aImage,
String aUri)
Updates the binary content of an existing image using a uri string.
|
void |
FileUtil.updateBinaryContent(Node aFile,
String aUri)
Updates the binary content of an existing file using a uri string.
|
void |
ImageUtil.updateBinaryContentFromBase64(Node aImage,
String aBase64EncodedString)
Updates the binary content of an existing image using a base64 string.
|
void |
FileUtil.updateBinaryContentFromBase64(Node aFile,
String aBase64EncodedString)
Updates the binary content of an existing file using a base64 string.
|
void |
ImageUtil.updateBinaryContentFromTemporary(Node aImage,
Node aTemporaryFile)
Updates the binary content of an existing image using a sv:temporaryFile.
|
void |
FileUtil.updateBinaryContentFromTemporary(Node aFile,
Node aTemporaryFile)
Updates the binary content of an existing file using a sv:temporaryFile.
|
void |
LinkPageUtil.updateLinkPage(Node aLinkPage,
Map<String,Object> aProperties)
Updates the properties of a link page.
|
void |
LinkPageUtil.updateLinkPageTarget(Node aLinkPage,
LinkTarget aLinkTarget)
Updates the target of a link page.
|
void |
PageUtil.updatePage(Node aPage,
Map<String,Object> properties)
Updates the properties of a page.
|
Modifier and Type | Method and Description |
---|---|
Node |
ArchiveUtil.createArchive(Node aParent,
String aName)
Creates an archive as sub node of the specified parent.
|
Node |
FolderUtil.createFolder(Node aParent,
String aName)
Creates a folder as sub node of the specified parent.
|
void |
TrashcanUtil.deleteNodeFromTrashcan(Node aNode)
Deletes a node from the site trashcan.
|
void |
StructureUtil.moveNode(Node aNode,
Node aParent)
Moves a node from the current parent to another in the node structure.
|
void |
TrashcanUtil.moveNodeToTrashcan(Node aNode)
Puts a node in the site trashcan.
|
void |
ArchiveUtil.renameArchive(Node anArchive,
String aName)
Alters the name of an archive.
|
void |
FolderUtil.renameFolder(Node aFolder,
String aName)
Alters the name of a folder.
|
void |
TrashcanUtil.restoreNode(Node aNode)
Restores a node from the site trashcan.
|
void |
FolderUtil.setDownloadProtected(Node aFolder,
boolean aDownloadProtected)
Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
|
void |
FolderUtil.setVersioned(Node aFolder,
boolean aVersioned)
Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
|
Modifier and Type | Method and Description |
---|---|
void |
WebContentUtil.appendContent(Node aNode,
Map<String,String> aContent)
Append the content to the existing node.
|
void |
WebContentUtil.appendContent(Node aNode,
String aContent)
Appends the content to the existing node.
|
void |
WebContentUtil.appendContentWithRawHtml(Node aNode,
Map<String,String> aContent)
Appends raw HTML (a HTML portlet is created) to the existing content of a node.
|
void |
WebContentUtil.appendContentWithRawHtml(Node aNode,
String aContent)
Appends raw HTML (a HTML portlet is created) to the existing content of a node.
|
void |
WebContentUtil.updateContent(Node aNode,
Map<String,String> aContent)
Alters the content of a sv:page, sv:article or a sv:template.
|
void |
WebContentUtil.updateContent(Node aNode,
String aContent)
Alters the content of a sv:page, sv:article or a sv:template.
|
void |
WebContentUtil.updateContentWithRawHtml(Node aNode,
Map<String,String> aContent)
Alters the content of a sv:page, sv:article or a sv:template with raw HTML (a HTML portlet is created).
|
void |
WebContentUtil.updateContentWithRawHtml(Node aNode,
String aContent)
Alters the content of a sv:page, sv:article or a sv:template with raw HTML (a HTML portlet is created).
|
Modifier and Type | Method and Description |
---|---|
void |
PublishingUtil.publishNode(Node aNode)
Publishes a node.
|
void |
PublishingUtil.publishNode(Node aNode,
Date aDate)
Schedules a node publish job for execution at a specified date.
|
void |
PublishingUtil.publishNode(Node aNode,
Date aPublishDate,
Date anUnpublishDate)
Schedules a node publish job for execution at a specified date and a node unpublish job for execution at another date.
|
void |
PublishingUtil.publishNodeWithNotification(Node aNode,
Date aNotificationDate)
Publishes a node instantly with a best before notification date.
|
void |
PublishingUtil.publishNodeWithNotification(Node aNode,
Date aPublishDate,
Date aNotificationDate)
Schedules a node publish job for execution at a specified date with a best before notification date.
|
void |
PublishingUtil.publishNodeWithNotification(Node aNode,
Date aPublishDate,
Date aUnpublishDate,
Date aNotificationDate)
Schedules a node publish job for execution at a specified date and a node unpublish job for execution at a later
date and a best before notification date.
|
void |
PublishingUtil.unpublishNode(Node aNode)
Unpublishes a node.
|
void |
PublishingUtil.unpublishNode(Node aNode,
Date aDate)
Schedules a node unpublish job for execution at a specified date.
|
Modifier and Type | Method and Description |
---|---|
void |
XmlParserUtil.parse(String aElementSelection,
Node aXmlFile,
String aCharset,
XmlElementHandler aXmlElementHandler)
Parse a file containing XML encoded with the supplied charset.
|
void |
XmlParserUtil.parse(String aElementSelection,
Node aXmlFile,
XmlElementHandler aXmlElementHandler)
Parse a file containing XML encoded using UTF-8.
|
Sitevision - Portal and Content Management Made Easy
Sitevision is an advanced Java enterprise portal product and a portlet container (JSR 286) that implements Java Content Repository (JSR 283).
Copyright© 2008-2022 Sitevision AB, all rights reserved.