Java Doc for Repository.java in » 6.0-JDK-Modules » jsr-283 » javax » jcr » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » 6.0 JDK Modules » jsr 283 » javax.jcr

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.jcr .Repository

Repository
public interface Repository extends Referenceable(Code)
	The entry point into the content repository. The `Repository` object is usually acquired through JNDI.

Field Summary
final public static String	LEVEL_1_SUPPORTED Indicates whether this implementation supports all level 1 features.
final public static String	LEVEL_2_SUPPORTED Indicates whether this implementation supports all level 2 features.
final public static String	OPTION_ACCESS_CONTROL_DISCOVERY_SUPPORTED Indicates whether this implementation supports access control discovery.
final public static String	OPTION_ACCESS_CONTROL_ENTRIES_SUPPORTED Indicates whether this implementation supports access control entries.
final public static String	OPTION_ACCESS_CONTROL_POLICIES_SUPPORTED Indicates whether this implementation supports access control policies.
final public static String	OPTION_ACTIVITIES_SUPPORTED Indicates whether this implementation supports activities.
final public static String	OPTION_BASELINES_SUPPORTED Indicates whether this implementation supports configurations and baselines.
final public static String	OPTION_JOURNALED_OBSERVATION_SUPPORTED Indicates whether this implementation supports journaled observation.
final public static String	OPTION_LIFECYCLE_SUPPORTED Indicates whether this implementation supports lifecycle management.
final public static String	OPTION_LOCKING_SUPPORTED Indicates whether this implementation supports locking.
final public static String	OPTION_NODE_TYPE_REG_SUPPORTED Indicates whether this implementation supports node type registration.
final public static String	OPTION_OBSERVATION_SUPPORTED Indicates whether this implementation supports asynchronous observation.
final public static String	OPTION_QUERY_SQL_SUPPORTED Indicates whether this implementation supports the SQL query language.
final public static String	OPTION_SIMPLE_VERSIONING_SUPPORTED Indicates whether this implementation supports simple versioning.
final public static String	OPTION_TRANSACTIONS_SUPPORTED Indicates whether this implementation supports transactions.
final public static String	OPTION_VERSIONING_SUPPORTED Indicates whether this implementation supports versioning.
final public static String	QUERY_XPATH_DOC_ORDER Indicates whether XPath queries return results in document order.
final public static String	QUERY_XPATH_POS_INDEX Indicates whether the index position notation for same-name siblings is supported within XPath queries.
final public static String	REP_NAME_DESC The descriptor key for the name of this repository implementation.
final public static String	REP_VENDOR_DESC The descriptor key for the name of the repository vendor.
final public static String	REP_VENDOR_URL_DESC The descriptor key for the URL of the repository vendor.
final public static String	REP_VERSION_DESC The descriptor key for the version of this repository implementation.
final public static String	SPEC_NAME_DESC The descriptor key for the name of the specification that this repository implements.
final public static String	SPEC_VERSION_DESC The descriptor key for the version of the specification that this repository implements.

Method Summary
public String	getDescriptor(String key) Returns the descriptor for the specified key.
public String[]	getDescriptorKeys() Returns a string array holding all descriptor keys available for this implementation. This set must contain at least the built-in keys defined by the string constants in this interface.
public Session	login(Credentials credentials, String workspaceName) Authenticates the user using the supplied `credentials`.
public Session	login(Credentials credentials) Equivalent to `login(credentials, null)`.
public Session	login(String workspaceName) Equivalent to `login(null, workspaceName)`. Parameters: workspaceName - the name of a workspace.
public Session	login() Equivalent to `login(null, null)`.

Field Detail

LEVEL_1_SUPPORTED
final public static String LEVEL_1_SUPPORTED(Code)
	Indicates whether this implementation supports all level 1 features. This descriptor should always be "true".

LEVEL_2_SUPPORTED
final public static String LEVEL_2_SUPPORTED(Code)
	Indicates whether this implementation supports all level 2 features. This descriptor will be either "true" or "false".

OPTION_ACCESS_CONTROL_DISCOVERY_SUPPORTED
final public static String OPTION_ACCESS_CONTROL_DISCOVERY_SUPPORTED(Code)
	Indicates whether this implementation supports access control discovery. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_ACCESS_CONTROL_ENTRIES_SUPPORTED
final public static String OPTION_ACCESS_CONTROL_ENTRIES_SUPPORTED(Code)
	Indicates whether this implementation supports access control entries. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_ACCESS_CONTROL_POLICIES_SUPPORTED
final public static String OPTION_ACCESS_CONTROL_POLICIES_SUPPORTED(Code)
	Indicates whether this implementation supports access control policies. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_ACTIVITIES_SUPPORTED
final public static String OPTION_ACTIVITIES_SUPPORTED(Code)
	Indicates whether this implementation supports activities. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_BASELINES_SUPPORTED
final public static String OPTION_BASELINES_SUPPORTED(Code)
	Indicates whether this implementation supports configurations and baselines. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_JOURNALED_OBSERVATION_SUPPORTED
final public static String OPTION_JOURNALED_OBSERVATION_SUPPORTED(Code)
	Indicates whether this implementation supports journaled observation. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_LIFECYCLE_SUPPORTED
final public static String OPTION_LIFECYCLE_SUPPORTED(Code)
	Indicates whether this implementation supports lifecycle management. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_LOCKING_SUPPORTED
final public static String OPTION_LOCKING_SUPPORTED(Code)
	Indicates whether this implementation supports locking. This descriptor will be either "true" or "false".

OPTION_NODE_TYPE_REG_SUPPORTED
final public static String OPTION_NODE_TYPE_REG_SUPPORTED(Code)
	Indicates whether this implementation supports node type registration. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_OBSERVATION_SUPPORTED
final public static String OPTION_OBSERVATION_SUPPORTED(Code)
	Indicates whether this implementation supports asynchronous observation. This descriptor will be either "true" or "false".

OPTION_QUERY_SQL_SUPPORTED
final public static String OPTION_QUERY_SQL_SUPPORTED(Code)
	Indicates whether this implementation supports the SQL query language. This descriptor will be either "true" or "false".

OPTION_SIMPLE_VERSIONING_SUPPORTED
final public static String OPTION_SIMPLE_VERSIONING_SUPPORTED(Code)
	Indicates whether this implementation supports simple versioning. This descriptor will be either "true" or "false". since: JCR 2.0

OPTION_TRANSACTIONS_SUPPORTED
final public static String OPTION_TRANSACTIONS_SUPPORTED(Code)
	Indicates whether this implementation supports transactions. This descriptor will be either "true" or "false".

OPTION_VERSIONING_SUPPORTED
final public static String OPTION_VERSIONING_SUPPORTED(Code)
	Indicates whether this implementation supports versioning. This descriptor will be either "true" or "false".

QUERY_XPATH_DOC_ORDER
final public static String QUERY_XPATH_DOC_ORDER(Code)
	Indicates whether XPath queries return results in document order. This descriptor will be either "true" or "false".

QUERY_XPATH_POS_INDEX
final public static String QUERY_XPATH_POS_INDEX(Code)
	Indicates whether the index position notation for same-name siblings is supported within XPath queries. This descriptor will be either "true" or "false".

REP_NAME_DESC
final public static String REP_NAME_DESC(Code)
	The descriptor key for the name of this repository implementation.

REP_VENDOR_DESC
final public static String REP_VENDOR_DESC(Code)
	The descriptor key for the name of the repository vendor.

REP_VENDOR_URL_DESC
final public static String REP_VENDOR_URL_DESC(Code)
	The descriptor key for the URL of the repository vendor.

REP_VERSION_DESC
final public static String REP_VERSION_DESC(Code)
	The descriptor key for the version of this repository implementation.

SPEC_NAME_DESC
final public static String SPEC_NAME_DESC(Code)
	The descriptor key for the name of the specification that this repository implements. For JCR 2.0 the value of this descriptor is "Content Repository for Java Technology API".

SPEC_VERSION_DESC
final public static String SPEC_VERSION_DESC(Code)
	The descriptor key for the version of the specification that this repository implements. For JCR 2.0 the value of this descriptor is "2.0".

Method Detail

getDescriptor
public String getDescriptor(String key)(Code)
	Returns the descriptor for the specified key. Used to query information about this repository implementation. The set of available keys can be found by calling Repository.getDescriptorKeys . If the specifed key is not found, `null` is returned. Parameters: key - a string corresponding to a descriptor for this repository implementation. a descriptor string

getDescriptorKeys
public String[] getDescriptorKeys()(Code)
	Returns a string array holding all descriptor keys available for this implementation. This set must contain at least the built-in keys defined by the string constants in this interface. Used in conjunction with Repository.getDescriptor(String name) to query information about this repository implementation. a string array holding all descriptor keys.

login

public Session login(Credentials credentials, String workspaceName) throws LoginException, NoSuchWorkspaceException, RepositoryException(Code)

Authenticates the user using the supplied credentials. If workspaceName is recognized as the name of an existing workspace in the repository and authorization to access that workspace is granted, then a new Session object is returned. The format of the string workspaceName depends upon the implementation.

If credentials is null, it is assumed that authentication is handled by a mechanism external to the repository itself (for example, through the JAAS framework) and that the repository implementation exists within a context (for example, an application server) that allows it to handle authorization of the request for access to the specified workspace.

If workspaceName is null, a default workspace is automatically selected by the repository implementation. This may, for example, be the "home workspace" of the user whose credentials were passed, though this is entirely up to the configuration and implementation of the repository. Alternatively, it may be a "null workspace" that serves only to provide the method Workspace.getAccessibleWorkspaceNames , allowing the client to select from among available "real" workspaces.

If authentication or authorization for the specified workspace fails, a LoginException is thrown.

If workspaceName is not recognized, a NoSuchWorkspaceException is thrown.
Parameters:
  credentials - The credentials of the user
Parameters:
  workspaceName - the name of a workspace. a valid session for the user to access the repository.
throws:
  LoginException - If the login fails.
throws:
  NoSuchWorkspaceException - If the specified workspaceName is not recognized.
throws:
  RepositoryException - if another error occurs.

login
public Session login(Credentials credentials) throws LoginException, RepositoryException(Code)
	Equivalent to `login(credentials, null)`. Parameters: credentials - The credentials of the user a valid session for the user to access the repository. throws: LoginException - If the login authentication fails. throws: RepositoryException - if another error occurs.

login
public Session login(String workspaceName) throws LoginException, NoSuchWorkspaceException, RepositoryException(Code)
	Equivalent to `login(null, workspaceName)`. Parameters: workspaceName - the name of a workspace. a valid session for the user to access the repository. throws: LoginException - If the login authentication fails. throws: NoSuchWorkspaceException - If the specified `workspaceName` is not recognized. throws: RepositoryException - if another error occurs.

login
public Session login() throws LoginException, RepositoryException(Code)
	Equivalent to `login(null, null)`. a valid session for the user to access the repository. throws: LoginException - If the login authentication fails. throws: RepositoryException - if another error occurs.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.