Package com.primavera.integration.client

Class LocalSession

java.lang.Object

com.primavera.integration.client.Session

com.primavera.integration.client.LocalSession

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class LocalSession
extends Session
implements Serializable

Local Session, used to avoid the RMI layer when running in Local Mode.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.primavera.integration.client.Session

BATCH_OVERRIDE, DEFAULT_BIND_PARAM_LIMIT_ON_LOAD, DEFAULT_LOCAL_BATCH_SIZE, DEFAULT_REMOTE_BATCH_SIZE, MAX_BIND_PARAM_LIMIT_ON_LOAD, MAX_BUSINESS_OBJECT_BATCH_SIZE, MIN_BIND_PARAM_LIMIT_ON_LOAD, MIN_BUSINESS_OBJECT_BATCH_SIZE

Constructor Summary

Constructors

Constructor	Description
LocalSession()

Method Summary

Modifier and Type	Method	Description
Object	getAdminConfigSetting(String name, Class type)
static Session	getAPISession(String dbId, String userId, String sessionId, String ip, String usessionId)
JobInfo[]	getCurrentJobs()	Retrieves job information for any current asynchronous jobs of this user.
static DatabaseInstance[]	getDatabaseInstances(String sUrl)	Retrieves all database instances supported by the server.
Map<Object,Object>	getTemplateMap(String templateId, String userId)
byte[]	getUCMDocument(String uuid, String version)	Gets the byte array of UCM document.
DocumentDetail	getUCMDocumentDetail(String uuid)	Gets the most recent version of a content repository document.
DocumentDetail[]	getUCMDocumentsRecentVersion(List<String> uuids)	Gets the most recent version of each document.
DocumentVersion[]	getUCMVersionHistory(String uuid)	Gets all the versions of a content repository document.
ObjectId	getUserObjectId()	Gets the user id of the current user.
ObjectId	getUSessionId()	Returns an ObjectId representation of the usession id
boolean	isValid()	Verifies if the session is valid.
Timestamp	loadSafetyDate()	Loads the safety date from the database.
static Session	login(String sUrl, String sDbId, String sUserName, String sPassword)
static Session	login(String sUrl, String sDbId, String sUserName, String sPassword, String remoteClientIP)	Logs in and obtains a Session object.
void	logout()	Notifies the server that this session is no longer needed and release any resource allocated for this session.
int	populateUPKLIST(ObjectId epsObjectId)
int	removeDeletedObjectsFromBaseline(String boTypeName, ObjectId origProjectId, ObjectId blProjectId, Collection<String> parentActivityIdsToConsider)	Removes certain child objects from a baseline which do not exist in the original project This method is only supported for local sessions.
void	updateLicense()

Methods inherited from class com.primavera.integration.client.Session

close, exportProjects, fixupWhereClause, getBatchFailOnFirstFlag, getBindParameterLimitOnLoad, getBusinessObjectBatchSize, getDatabaseEncoding, getDatabaseInstanceId, getDatabaseName, getDatabaseType, getDatabaseTypeEnum, getDatabaseUrl, getEnterpriseLoadManager, getGlobalObjectManager, getJobManager, getSessionId, getUserName, importProjects, isLocalModeAvailable, isRemoteModeAvailable, pagingLoad, setBatchFailOnFirstFlag, setBindParameterLimitOnLoad, setBusinessObjectBatchSize, setExportOption, setIpmDarExportOption

Methods inherited from class java.lang.Object

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

Constructor Details

LocalSession

public LocalSession()

Method Details

getDatabaseInstances

public static DatabaseInstance[] getDatabaseInstances(String sUrl)
                                               throws ServerException

Retrieves all database instances supported by the server.

Parameters:

sUrl - identify the location of the server

Returns:

DatabaseInstance[] array of DatabaseInstance objects representing available databases

Throws:

ServerException - if a problem occurred on the server-side

login

public static Session login(String sUrl,
 String sDbId,
 String sUserName,
 String sPassword)
                     throws ServerException

Throws:

ServerException

login

public static Session login(String sUrl,
 String sDbId,
 String sUserName,
 String sPassword,
 String remoteClientIP)
                     throws ServerException

Logs in and obtains a Session object.

Parameters:

sUrl - the location of the server

sDbId - the database instance id

sUserName - the user name

sPassword - the password

Returns:

Session session object

Throws:

ServerException - if a problem occurred on the server-side

logout

public void logout()

Notifies the server that this session is no longer needed and release any resource allocated for this session. You should always call logout after you finish working with the api.

Specified by:

logout in class Session

isValid

public boolean isValid()

Verifies if the session is valid.

Specified by:

isValid in class Session

Returns:

true if session is valid

getUserObjectId

public ObjectId getUserObjectId()
                         throws ServerException

Gets the user id of the current user.

Specified by:

getUserObjectId in class Session

Returns:

ObjectId the user object id

Throws:

ServerException - if a problem occurred on the server-side

getUSessionId

public ObjectId getUSessionId()
                       throws ServerException

Returns an ObjectId representation of the usession id

Specified by:

getUSessionId in class Session

Returns:

ObjectId USessionId

Throws:

ServerException - if a problem occurred on the server-side

removeDeletedObjectsFromBaseline

public int removeDeletedObjectsFromBaseline(String boTypeName,
 ObjectId origProjectId,
 ObjectId blProjectId,
 Collection<String> parentActivityIdsToConsider)
                                     throws ServerException

Description copied from class: Session

Removes certain child objects from a baseline which do not exist in the original project This method is only supported for local sessions.

Overrides:

removeDeletedObjectsFromBaseline in class Session

Parameters:

boTypeName - - the type of objects to remove. Supported type names are ["ActivityCodeAssignment", "ActivityUDFValue"]

origProjectId - - ObjectId of original project

blProjectId - - ObjectId of the baseline project

parentActivityIdsToConsider - - If non-null, only the child objects owned by these activities will be considered for removal

Returns:

The number of objects deleted

Throws:

ServerException - if a problem occurred on the server-side, or an unsupported bOTypeName was provided, or if this method was called from a non-local session

getCurrentJobs

public JobInfo[] getCurrentJobs()
                         throws ServerException

Retrieves job information for any current asynchronous jobs of this user.

Returns:

JobInfo[] array of JobInfo

Throws:

ServerException - if a problem occurred on the server-side

loadSafetyDate

public Timestamp loadSafetyDate()
                         throws ServerException

Description copied from class: Session

Loads the safety date from the database. The safety date can be used to identify business objects that have been updated since the last load of the safety date.

Specified by:

loadSafetyDate in class Session

Returns:

the safety date

Throws:

ServerException - when a Server exception occurs

getUCMDocument

public byte[] getUCMDocument(String uuid,
 String version)
                      throws Exception

Description copied from class: Session

Gets the byte array of UCM document.

Specified by:

getUCMDocument in class Session

Parameters:

uuid - the UCM ID of a document.

version - the version of the document.

Returns:

the contents of a content repository document.

Throws:

Exception - if a problem occurred.

getUCMVersionHistory

public DocumentVersion[] getUCMVersionHistory(String uuid)
                                       throws Exception

Description copied from class: Session

Gets all the versions of a content repository document.

Specified by:

getUCMVersionHistory in class Session

Parameters:

uuid - the ID of a content repository document.

Returns:

all versions of a content repository document.

Throws:

Exception - if a problem occurred.

getUCMDocumentsRecentVersion

public DocumentDetail[] getUCMDocumentsRecentVersion(List<String> uuids)
                                              throws Exception

Description copied from class: Session

Gets the most recent version of each document.

Specified by:

getUCMDocumentsRecentVersion in class Session

Parameters:

uuids - the unique ID of content repository documents.

Returns:

the most recent version of content repository documents.

Throws:

Exception - if a problem occurred.

getUCMDocumentDetail

public DocumentDetail getUCMDocumentDetail(String uuid)
                                    throws Exception

Description copied from class: Session

Gets the most recent version of a content repository document.

Specified by:

getUCMDocumentDetail in class Session

Parameters:

uuid - the unique ID of a content repository document.

Returns:

the recent version a content repository document.

Throws:

Exception - if a problem occurred.

populateUPKLIST

public int populateUPKLIST(ObjectId epsObjectId)
                    throws ServerException,
NetworkException

Specified by:

populateUPKLIST in class Session

Throws:

ServerException

NetworkException

getTemplateMap

public Map<Object,Object> getTemplateMap(String templateId,
 String userId)
                                  throws ServerException,
NetworkException

Specified by:

getTemplateMap in class Session

Throws:

ServerException

NetworkException

updateLicense

public void updateLicense()
                   throws ServerException,
NetworkException

Specified by:

updateLicense in class Session

Throws:

ServerException

NetworkException

getAdminConfigSetting

public Object getAdminConfigSetting(String name,
 Class type)
                             throws ServerException,
NetworkException

Specified by:

getAdminConfigSetting in class Session

Throws:

ServerException

NetworkException

getAPISession

public static Session getAPISession(String dbId,
 String userId,
 String sessionId,
 String ip,
 String usessionId)