Package org.onehippo.repository.scheduling

Class RepositoryJobExecutionContext

java.lang.Object

org.onehippo.repository.scheduling.RepositoryJobExecutionContext

public class RepositoryJobExecutionContext
extends Object

Context object containing operational information and helper objects for use by RepositoryJobs to do their job.

Constructor Summary

Constructors

Constructor	Description
RepositoryJobExecutionContext(Session systemSession, Map<String,String> attributes)

Method Summary

Modifier and Type	Method	Description
Session	createSession(Credentials credentials)	Create a session with the given credentials.
Session	createSystemSession()	Get a system session.
String	getAttribute(String name)	Get an attribute value.
Collection<String>	getAttributeNames()
Session	getSession(Credentials credentials)	Deprecated. use createSession(javax.jcr.Credentials) instead
Session	getSystemSession()	Deprecated. use createSystemSession() instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RepositoryJobExecutionContext

public RepositoryJobExecutionContext(Session systemSession,
                                     Map<String,String> attributes)

Method Detail

getSession

@Deprecated
public Session getSession(Credentials credentials)
                   throws LoginException,
                          RepositoryException

Deprecated.

use createSession(javax.jcr.Credentials) instead

Get a session with the given credentials. Caller must log out the returned session after use.

Throws:

LoginException

RepositoryException

createSession

public Session createSession(Credentials credentials)
                      throws LoginException,
                             RepositoryException

Create a session with the given credentials. Caller must log out the returned session after use.

Throws:

LoginException

RepositoryException

getSystemSession

@Deprecated
public Session getSystemSession()
                         throws LoginException,
                                RepositoryException

Deprecated.

use createSystemSession() instead

Create a system session. Caller must log out the returned session after use.

Throws:

LoginException

RepositoryException

createSystemSession

public Session createSystemSession()
                            throws LoginException,
                                   RepositoryException

Get a system session. Caller must log out the returned session after use.

Throws:

LoginException

RepositoryException

getAttribute

public String getAttribute(String name)

Get an attribute value. You can pass attributes to this context object through RepositoryJobInfo.setAttribute(String, String).

Parameters:

name - the name of the attribute.

Returns:

the attribute value associated with name.

getAttributeNames

public Collection<String> getAttributeNames()

Returns:

the collection of all the attribute names.