fuego.papi
Class ProcessService

java.lang.Object

  fuego.papi.ProcessService

public abstract class ProcessService

extends Object

Main class in PAPI framework.

This service provide the connection with fuego engine and is the one that handle every event.
The main use for PAPI users is the creation of sessions (ProcessServiceSession or ProcessServiceNESession) after receiving the participant credential.

example:

ProcessService processService = ProcessService.create(directoryUrl);
ProcessServiceSession session = processService.createSession(userId, userPassword, cacheEnabled);

See Also:

ProcessServiceSession, ProcessServiceNESession

Nested Class Summary

static interface

ProcessService.Factory

Field Summary

static int

DEFAULT_CACHE_SIZE

Constructor Summary

ProcessService()

Method Summary

abstract void	close() Close the service, and disconnect all the sessions that are still connected.
static ProcessService	create(fuego.directory.DirectoryPassport passport, String baseFolder, int instancesCacheSize)
static ProcessService	create(String url) Temporary method
static ProcessService	create(String url, String baseFolder) Creates a new ProcessService.
static ProcessService	create(String url, String baseFolder, int instancesCacheSize) Creates a new ProcessService.
static ProcessService	create(String url, String id, String baseFolder, int instancesCacheSize) Creates a new ProcessService.
static Filter	createFilter() Return a new Filter
static Filter	createFilter(int matchingCriteria) Deprecated.
abstract ProcessServiceNESession	createNESession(fuego.lang.ConnectionPassport passport, String host) Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(ConnectionPassport, String) instead
abstract ProcessServiceNESession	createNESession(fuego.lang.ConnectionPassport passport, String host, boolean takeOver) Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(ConnectionPassport, String) instead
abstract ProcessServiceNESession	createNESession(String userId, String password, String host) Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(String, String, String) instead
abstract ProcessServiceNESession	createNESession(String userId, String password, String host, boolean takeOver) Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(String, String, String) instead
abstract fuego.lang.ConnectionPassport	createPassport(String participant) Returns a directory passport to connect to the process service.
abstract fuego.lang.ConnectionPassport	createPassportWithPreset(String preset) Returns a directory passport with preset to connect to the process service.
abstract ProcessServiceSession	createSession(fuego.lang.ConnectionPassport passport, String host) Creates a ProcessService session.
abstract ProcessServiceSession	createSession(fuego.lang.ConnectionPassport passport, String host, boolean takeOver) Deprecated. takeOver argument is not longer supported. Use createSession(ConnectionPassport, String) instead
abstract ProcessServiceSession	createSession(String userId, String password, String host) Creates a ProcessService session.
abstract ProcessServiceSession	createSession(String userId, String password, String host, boolean takeOver) Deprecated. takeOver argument is not longer supported. Use createSession(String, String, String) instead
static ProcessService	createWithId(String id) Temporary method
static ProcessService	createWithId(String id, String baseFolder) Creates a new ProcessService.
static ProcessService	createWithId(String id, String baseFolder, int instancesCacheSize) Creates a new ProcessService.
abstract String	getUserDocumentationFolder() Returns the user folder for storing process documentation
static char[]	invalidIdCharacters() Set of invalid values accepted in an identification.
abstract void	setLocale(Locale locale, ProcessServiceNESession session) Sets the given locale in all the connected engines by the given Session, in order to receive all the messages from them in this locale.
abstract void	setUserDocumentationFolder(String userDocumentationFolder) Sets the user folder for storing process documentation
abstract void	startUpdater(fuego.lang.ConnectionPassport passport, long updateFrecuency) Starts the updater in order to realize every change in the views, presentations and groups.
abstract void	startViewUpdater(fuego.lang.ConnectionPassport passport, long updateFrecuency) Deprecated.
abstract void	stopUpdater() Stops the updater If the updater was not initialized previously, nothing is done
abstract void	stopViewUpdater() Deprecated.
abstract String	toString() Return an object description
static void	updateOrganizationalInformationFromDirectory()
abstract void	updateSessionViewsForNewInstances(boolean updateSessionViews) Notify sessions when an instance is updated, was created or was completed to update.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

Constructor Detail

ProcessService

public ProcessService()

Method Detail

setLocale

public abstract void setLocale(Locale locale,
                               ProcessServiceNESession session)
                        throws OperationException

Sets the given locale in all the connected engines by the given Session, in order to receive all the messages from them in this locale. param locale The new locale. param session The session where the locale has changed.

Throws:

OperationException

setUserDocumentationFolder

public abstract void setUserDocumentationFolder(String userDocumentationFolder)

Sets the user folder for storing process documentation

getUserDocumentationFolder

public abstract String getUserDocumentationFolder()

Returns the user folder for storing process documentation

Returns:

String The path of the local folder for process documentation

close

public abstract void close()

Close the service, and disconnect all the sessions that are still connected.

createNESession

public abstract ProcessServiceNESession createNESession(String userId,
                                                        String password,
                                                        String host)
                                                 throws OperationException

Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(String, String, String) instead

Creates a Not Exclusive ProcessService session. Through this session the Participant will be able to perform all those not exclusive operations, meaning the Participant can have more that one of this sessions opened at the same time.

Throws:

OperationException

createNESession

public abstract ProcessServiceNESession createNESession(String userId,
                                                        String password,
                                                        String host,
                                                        boolean takeOver)
                                                 throws OperationException

Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(String, String, String) instead

Creates a Not Exclusive ProcessService session. Through this session the Participant will be able to perform all those not exclusive operations, meaning the Participant can have more that one of this sessions opened at the same time.

Parameters:

userId - String containing the user's uid or login name

password - String containing in cleartext the user's password for this directory

host - The host where the participant is connected from. The Fuego Administrator can track this from the Execution Console.

takeOver - If this session should connect to an Engine where the same participant is already connected from another location (taking over of the connection in that Engine)

Returns:

a nonexclusive session to operate

Throws:

OperationException - if the user couldn't be authenticated against the directory server

See Also:

ProcessServiceNESession, ProcessServiceSession

createNESession

public abstract ProcessServiceNESession createNESession(fuego.lang.ConnectionPassport passport,
                                                        String host)
                                                 throws OperationException

Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(ConnectionPassport, String) instead

Creates a Not Exclusive ProcessService session. Through this session the Participant will be able to perform all those not exclusive operations, meaning the Participant can have more that one of this sessions opened at the same time.

Throws:

OperationException

createNESession

public abstract ProcessServiceNESession createNESession(fuego.lang.ConnectionPassport passport,
                                                        String host,
                                                        boolean takeOver)
                                                 throws OperationException

Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use createSession(ConnectionPassport, String) instead

Creates a Not Exclusive ProcessService session. Through this session the Participant will be able to perform all those not exclusive operations, meaning the Participant can have more that one of this sessions opened at the same time.

Parameters:

passport - a directory passport that provides the participant information

host - The host where the participant is connected from. The Fuego Administrator can track this from the Execution Console.

takeOver - If this session should connect to an Engine where the same participant is already connected from another location (taking over of the connection in that Engine)

Returns:

a nonexclusive session to operate

Throws:

OperationException

See Also:

ProcessServiceNESession, ProcessServiceSession

createPassport

public abstract fuego.lang.ConnectionPassport createPassport(String participant)

Returns a directory passport to connect to the process service. The participant may be null, representing an anonymous connection

Returns:

a passport for the process service for the participant

createPassportWithPreset

public abstract fuego.lang.ConnectionPassport createPassportWithPreset(String preset)

Returns a directory passport with preset to connect to the process service.

Returns:

a passport for the process service for the preset

createSession

public abstract ProcessServiceSession createSession(String userId,
                                                    String password,
                                                    String host)
                                             throws OperationException

Creates a ProcessService session. Through this session the Participant will be able to perform all operations.

Throws:

OperationException

createSession

public abstract ProcessServiceSession createSession(String userId,
                                                    String password,
                                                    String host,
                                                    boolean takeOver)
                                             throws OperationException

Deprecated. takeOver argument is not longer supported. Use createSession(String, String, String) instead

Creates an Exclusive ProcessService session. Through this session the Participant will be able to perform all operations. Only one session can be open by the same Participant at the same time.

Parameters:

userId - String containing the user's uid or login name

password - String containing in cleartext the user's password for this directory

host - The host where the participant is connected from. The Fuego Administrator can track this from the Execution Console.

takeOver - If this session should connect to an Engine where the same participant is already connected from another location (taking over of the connection in that Engine)

Returns:

a session to operate with processes

Throws:

OperationException - if the user couldn't be authenticated against the directory server

See Also:

ProcessServiceSession

createSession

public abstract ProcessServiceSession createSession(fuego.lang.ConnectionPassport passport,
                                                    String host)
                                             throws OperationException

Creates a ProcessService session. Through this session the Participant will be able to perform all operations.

Throws:

OperationException

createSession

public abstract ProcessServiceSession createSession(fuego.lang.ConnectionPassport passport,
                                                    String host,
                                                    boolean takeOver)
                                             throws OperationException

Deprecated. takeOver argument is not longer supported. Use createSession(ConnectionPassport, String) instead

Creates an Exclusive ProcessService session. Through this session the Participant will be able to perform all operations. Only one session can be open by the same Participant at the same time.

Parameters:

passport - a directory passport that provides the participant information

host - The host where the participant is connected from. The Fuego Administrator can track this from the Execution Console.

takeOver - If this session should connect to an Engine where the same participant is already connected from another location (taking over of the connection in that Engine)

Returns:

an exclusive session to operate

Throws:

OperationException

See Also:

ProcessServiceNESession, ProcessServiceSession

startUpdater

public abstract void startUpdater(fuego.lang.ConnectionPassport passport,
                                  long updateFrecuency)
                           throws OperationException

Starts the updater in order to realize every change in the views, presentations and groups.

Parameters:

passport - Passport to create a new session that will be use to sinchronize.

updateFrecuency - Frecuency to sinchronize views, in milliseconds.

Throws:

OperationException

startViewUpdater

public abstract void startViewUpdater(fuego.lang.ConnectionPassport passport,
                                      long updateFrecuency)
                               throws OperationException

Deprecated.

Starts the view updater in order to realize every change in the directory views

Parameters:

passport - Passport to create a new session that will be use to sinchronize views

updateFrecuency - Frecuency to sinchronize views, in milliseconds.

Throws:

OperationException

stopUpdater

public abstract void stopUpdater()
                          throws OperationException

Stops the updater If the updater was not initialized previously, nothing is done

Throws:

OperationException

stopViewUpdater

public abstract void stopViewUpdater()
                              throws OperationException

Deprecated.

Stops the view updater If the updater was not initialized previously, nothing is done

Throws:

OperationException

toString

public abstract String toString()

Return an object description

Returns:

object description

create

public static ProcessService create(String url)
                             throws CommunicationException

Temporary method

Throws:

CommunicationException

create

public static ProcessService create(String url,
                                    String baseFolder)
                             throws CommunicationException

Creates a new ProcessService. This will serve all the request of operations over processes in the given Directory.

Parameters:

url - The url of the fuego directory

baseFolder - The local folder where to store catalogs jars (containing XObject classes) and process/activity documentation

Returns:

ProcessService A ProcessService serving for directory at url

Throws:

CommunicationException

create

public static ProcessService create(String url,
                                    String baseFolder,
                                    int instancesCacheSize)
                             throws CommunicationException

Creates a new ProcessService. This will serve all the request of operations over processes in the given Directory.

Parameters:

url - The url of the fuego directory

baseFolder - The local folder where to store catalogs jars (containing XObject classes) and process/activity documentation

instancesCacheSize - Max instances cache size per process

Returns:

ProcessService A ProcessService serving for directory at url

Throws:

CommunicationException

create

public static ProcessService create(fuego.directory.DirectoryPassport passport,
                                    String baseFolder,
                                    int instancesCacheSize)
                             throws CommunicationException

Throws:

CommunicationException

create

public static ProcessService create(String url,
                                    String id,
                                    String baseFolder,
                                    int instancesCacheSize)
                             throws CommunicationException

Creates a new ProcessService. This will serve all the request of operations over processes in the given Directory.

Parameters:

url - The url of the fuego directory. If null it will try to obtain it from the fuego directory id.

id - The id of the fuego directory.

baseFolder - The local folder where to store catalogs jars (containing XObject classes) and process/activity documentation

instancesCacheSize - Max instances cache size per process

Returns:

ProcessService A ProcessService serving for directory at url

Throws:

CommunicationException

createFilter

public static Filter createFilter()

Return a new Filter

Returns:

createFilter

public static Filter createFilter(int matchingCriteria)

Deprecated.

Return a new Filter

Parameters:

matchingCriteria - (this value is ignored)

Returns:

createWithId

public static ProcessService createWithId(String id)
                                   throws CommunicationException

Temporary method

Throws:

CommunicationException

createWithId

public static ProcessService createWithId(String id,
                                          String baseFolder)
                                   throws CommunicationException

Creates a new ProcessService. This will serve all the request of operations over processes in the given Directory.

Parameters:

id - The directory ID of the fuego directory

baseFolder - The local folder where to store catalogs jars (containing XObject classes) and process/activity documentation

Returns:

a ProcessService on then directory at id

Throws:

CommunicationException

createWithId

public static ProcessService createWithId(String id,
                                          String baseFolder,
                                          int instancesCacheSize)
                                   throws CommunicationException

Creates a new ProcessService. This will serve all the request of operations over processes in the given Directory.

Parameters:

id - The directory ID of the fuego directory

baseFolder - The local folder where to store catalogs jars (containing XObject classes) and process/activity documentation

instancesCacheSize - Max instances cache size per process

Returns:

a ProcessService on then directory at id

Throws:

CommunicationException

invalidIdCharacters

public static char[] invalidIdCharacters()

Set of invalid values accepted in an identification.

Returns:

invalid character set accepted in a view id

updateSessionViewsForNewInstances

public abstract void updateSessionViewsForNewInstances(boolean updateSessionViews)

Notify sessions when an instance is updated, was created or was completed to update. If you set True, the sessions will be updated to check if the session or a view has new instances. If you set False, the sessions will not be updated and the methods to check if the session or a view has new instances, return false.

Parameters:

updateSessionViews - True if you want to use the method ProcessServiceNESession.hasNewInstances(...) This method has effects over the method ProcessServiceNESession.hasNewInstances(...)

See Also:

ProcessServiceNESession.hasNewInstances(), ProcessServiceNESession.hasNewInstances(String)

updateOrganizationalInformationFromDirectory

public static void updateOrganizationalInformationFromDirectory()