org.fcrepo.kernel.api.services

Interface BatchService

All Known Implementing Classes:

BatchServiceImpl

public interface BatchService

Since:

Sept 30, 2016

Author:

acoburn

Method Summary

Modifier and Type	Method and Description
default void	abort(String sessionId) Roll back any uncommited changes during a FedoraSession for the anonymous user
void	abort(String sessionId, String username) Roll back any uncommited changes during a FedoraSession
default void	begin(FedoraSession session) Create a new batch operation with a FedoraSession for the anonymous user and add it to the currently open ones
void	begin(FedoraSession session, String username) Create a new batch operation with a FedoraSession and add it to the currently open ones
default void	commit(String sessionId) Commit any changes during a FedoraSession with the given id for the anonymous user
void	commit(String sessionId, String username) Commit any changes during a FedoraSession with the given id and username
default boolean	exists(String sessionId) Check if a FedoraSession exists for the anonymous user
boolean	exists(String sessionId, String username) Check if a FedoraSession exists for a particular user
default FedoraSession	getSession(String sessionId) Retrieve an open FedoraSession for an anonymous user
FedoraSession	getSession(String sessionId, String username) Retrieve an open FedoraSession for a given user
void	refresh(String sessionId, String username) Refresh an existing session using an implementation-defined default
void	removeExpired() Check for expired batch operations and remove them

Method Detail

removeExpired

void removeExpired()

Check for expired batch operations and remove them

begin

void begin(FedoraSession session,
           String username)

Create a new batch operation with a FedoraSession and add it to the currently open ones

Parameters:

session - The session to use for this batch operation

username - the name of the Principal

begin

default void begin(FedoraSession session)

Create a new batch operation with a FedoraSession for the anonymous user and add it to the currently open ones

Parameters:

session - The session to use for this batch operation

getSession

FedoraSession getSession(String sessionId,
                         String username)

Retrieve an open FedoraSession for a given user

Parameters:

sessionId - the Id of the FedoraSession

username - the name of the Principal

Returns:

the FedoraSession with this user

getSession

default FedoraSession getSession(String sessionId)

Retrieve an open FedoraSession for an anonymous user

Parameters:

sessionId - the Id of the FedoraSession

Returns:

the FedoraSession

exists

boolean exists(String sessionId,
               String username)

Check if a FedoraSession exists for a particular user

Parameters:

sessionId - the Id of the FedoraSession

username - the name of the Principal

Returns:

the FedoraSession object for the defined user

exists

default boolean exists(String sessionId)

Check if a FedoraSession exists for the anonymous user

Parameters:

sessionId - the Id of the FedoraSession

Returns:

the FedoraSession object

refresh

void refresh(String sessionId,
             String username)

Refresh an existing session using an implementation-defined default

Parameters:

sessionId - the Id of the FedoraSession

username - the name of the Principal

commit

void commit(String sessionId,
            String username)

Commit any changes during a FedoraSession with the given id and username

Parameters:

sessionId - the id of the FedoraSession

username - the name of the Principal

commit

default void commit(String sessionId)

Commit any changes during a FedoraSession with the given id for the anonymous user

Parameters:

sessionId - the id of the FedoraSession

abort

void abort(String sessionId,
           String username)

Roll back any uncommited changes during a FedoraSession

Parameters:

sessionId - the id of the FedoraSession

username - the name of the Principal

abort

default void abort(String sessionId)

Roll back any uncommited changes during a FedoraSession for the anonymous user

Parameters:

sessionId - the id of the FedoraSession