ModeShape Distribution 3.5.0.Final

org.modeshape.jcr.api
Interface Session

All Superinterfaces:
Session

public interface Session
extends Session

A specialization of the standard JCR Session interface that returns the ModeShape-specific extension interfaces from getWorkspace() and getRepository().


Field Summary
 
Fields inherited from interface javax.jcr.Session
ACTION_ADD_NODE, ACTION_READ, ACTION_REMOVE, ACTION_SET_PROPERTY
 
Method Summary
 String decode(String localName)
          Evaluate a local name and replace any characters that were previously encoded.
 String encode(String localName)
          Evaluate a local name and replace any characters that are not allowed within the local names of nodes and properties.
 Repository getRepository()
           
 Workspace getWorkspace()
           
 
Methods inherited from interface javax.jcr.Session
addLockToken, checkPermission, exportDocumentView, exportDocumentView, exportSystemView, exportSystemView, getAccessControlManager, getAttribute, getAttributeNames, getImportContentHandler, getItem, getLockTokens, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNode, getNodeByIdentifier, getNodeByUUID, getProperty, getRetentionManager, getRootNode, getUserID, getValueFactory, hasCapability, hasPendingChanges, hasPermission, impersonate, importXML, isLive, itemExists, logout, move, nodeExists, propertyExists, refresh, removeItem, removeLockToken, save, setNamespacePrefix
 

Method Detail

getWorkspace

Workspace getWorkspace()
Specified by:
getWorkspace in interface Session

getRepository

Repository getRepository()
Specified by:
getRepository in interface Session

encode

String encode(String localName)
Evaluate a local name and replace any characters that are not allowed within the local names of nodes and properties. Such characters include '/', ':', '[', ']', '*', and '|', since these are all important to the rules for qualified names and paths. When such characters are to be used within a local name, the application must escape them using this method before the local name is used.

Parameters:
localName - the local name to be encoded; can be null or empty
Returns:
the supplied local name if it contains no illegal characters, or the encoded form of the supplied local name with all illegal characters replaced, or null if the input was null
See Also:
Session.move(String, String), Node.addNode(String), Node.addNode(String, String)

decode

String decode(String localName)
Evaluate a local name and replace any characters that were previously encoded.

Parameters:
localName - the local name to be decoded; can be null or empty
Returns:
the supplied local name if it contains no encoded characters, or the decoded form of the supplied local name with all encoded characters replaced, or null if the input was null
See Also:
encode(String)

ModeShape Distribution 3.5.0.Final

Copyright © 2008-2013 JBoss, a division of Red Hat. All Rights Reserved.