LaColla.Api
Interface Api

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ApiImpl, ApplicationsSideApiWrapper

public interface Api
extends java.rmi.Remote

Method Summary

java.lang.String	addGroup(java.lang.String userId, java.lang.String groupId, GroupInfo groupInfo)
java.lang.String	addMember(java.lang.String memberId, java.lang.String groupId, ObjectLaCOLLA memberInfo, java.lang.String role, java.lang.String username, java.lang.String password, java.lang.String emailAddress)
void	disseminateEvent(java.lang.String groupId, Event evt) Deprecated.
void	disseminateEvent(java.lang.String groupId, Event evt)
java.util.ArrayList	eventsRelatedTo(java.lang.String groupId, java.lang.String objectId)
GroupInfo	getInfoGroup(java.lang.String userId, java.lang.String groupId, java.lang.String aplicId)
void	getInfoMember(ObjectLaCOLLA obj, java.lang.String localPath) Deprecated.
ObjectLaCOLLA	getInfoMember(java.lang.String memberId, java.lang.String groupId, java.lang.String localPath)
void	getInfoObject(java.lang.String groupId, java.lang.String objectId)
void	getObject(ObjectLaCOLLA obj, java.lang.String localPath) Deprecated.
void	getObject(ObjectLaCOLLA obj, java.lang.String localPath)
void	getTaskState(java.lang.String idTask, java.lang.String groupId)
java.lang.String	login(java.lang.String groupId, java.lang.String userId, java.lang.String pswd)
java.lang.String	login(java.lang.String groupId, java.lang.String username, java.lang.String pswd, java.lang.String GapaHost, int GapaPort, java.lang.String appHost, int appPort)
java.lang.String	login(java.lang.String groupId, java.lang.String username, java.lang.String pswd, java.lang.String GapaHost, int GapaPort, java.lang.String appHost, int appPort, TimestampSummary eventSummary)
void	logout(java.lang.String groupId, java.lang.String userId, java.lang.String aplicName)
ObjectLaCOLLA	putObject(ObjectLaCOLLA obj) Deprecated.
ObjectLaCOLLA	putObject(ObjectLaCOLLA obj)
void	removeGroup(java.lang.String userId, java.lang.String groupId)
void	removeObject(java.lang.String groupId, java.lang.String objectId)
void	sendInstantMessage(java.lang.String memberId, java.lang.String groupId, java.lang.Object message, java.util.ArrayList targetList)
void	stopTask(java.lang.String idTask, java.lang.String groupId)
java.lang.String	submitTask(byte[] xml, java.lang.String groupId)

Method Detail

login

java.lang.String login(java.lang.String groupId,
                       java.lang.String userId,
                       java.lang.String pswd)
                       throws java.rmi.RemoteException

Parameters:

groupId - - the groupId

userId - - Username

pswd - - Password

Returns:

String appId - the application id provided by LaCOLLA

Throws:

java.rmi.RemoteException

login

java.lang.String login(java.lang.String groupId,
                       java.lang.String username,
                       java.lang.String pswd,
                       java.lang.String GapaHost,
                       int GapaPort,
                       java.lang.String appHost,
                       int appPort)
                       throws java.rmi.RemoteException

Parameters:

groupId - the group name (can be an string or the ID generated by tyrex)

username - User name (the nick, not the tyrex ID)

pswd - Password

GapaHost - the GAPA host

GapaPort - the GAPA port

appHost - the Application host

appPort - the Application port

Returns:

applicationID

Throws:

java.rmi.RemoteException

login

java.lang.String login(java.lang.String groupId,
                       java.lang.String username,
                       java.lang.String pswd,
                       java.lang.String GapaHost,
                       int GapaPort,
                       java.lang.String appHost,
                       int appPort,
                       TimestampSummary eventSummary)
                       throws java.rmi.RemoteException

Parameters:

groupId - the group name (can be an string or the ID generated by tyrex)

username - User name (the nick, not the tyrex ID)

pswd - Password

GapaHost - the GAPA host

GapaPort - the GAPA port

appHost - the Application host

appPort - the Application port

eventSummary - the summary of events received

Returns:

applicationID

Throws:

java.rmi.RemoteException

logout

void logout(java.lang.String groupId,
            java.lang.String userId,
            java.lang.String aplicName)
            throws java.rmi.RemoteException

Parameters:

groupId - - the groupId

userId - - Username

aplicName - - the application id provided by LaCOLLA

Throws:

java.rmi.RemoteException

disseminateEvent

void disseminateEvent(java.lang.String groupId,
                      Event evt)
                      throws java.rmi.RemoteException

Deprecated.

Parameters:

groupId - - the groupId

evt - - the event to disseminate

Throws:

java.rmi.RemoteException

disseminateEvent

void disseminateEvent(java.lang.String groupId,
                      Event evt)
                      throws java.rmi.RemoteException

Parameters:

groupId - - the groupId

evt - - the event to disseminate

Throws:

java.rmi.RemoteException

eventsRelatedTo

java.util.ArrayList eventsRelatedTo(java.lang.String groupId,
                                    java.lang.String objectId)
                                    throws java.rmi.RemoteException

Parameters:

groupId - - the groupId

objectId - - the objectId

Returns:

ArrayList - list of events related to the objectId

Throws:

java.rmi.RemoteException

putObject

ObjectLaCOLLA putObject(ObjectLaCOLLA obj)
                        throws java.rmi.RemoteException

Deprecated.

Parameters:

obj - - the ObjectLaCOLLA to be stored

Returns:

ObjectLaCOLLA - the obj descriptor. Includes the objectId

Throws:

java.rmi.RemoteException

putObject

ObjectLaCOLLA putObject(ObjectLaCOLLA obj)
                        throws java.rmi.RemoteException

Parameters:

obj - - the ObjectLaCOLLA to be stored

Returns:

ObjectLaCOLLA - the obj descriptor. Includes the objectId

Throws:

java.rmi.RemoteException

getObject

void getObject(ObjectLaCOLLA obj,
               java.lang.String localPath)
               throws java.rmi.RemoteException

Deprecated.

Parameters:

obj - - the ObjectLaCOLLA to obtain

Throws:

java.rmi.RemoteException

getObject

void getObject(ObjectLaCOLLA obj,
               java.lang.String localPath)
               throws java.rmi.RemoteException

Parameters:

obj - - the ObjectLaCOLLA to obtain. This object must be filled with the objectId and group Id.

localPath - - the qualified filename where LaCOLLA will store the file bytes

Throws:

java.rmi.RemoteException - Status: working

getInfoObject

void getInfoObject(java.lang.String groupId,
                   java.lang.String objectId)
                   throws java.rmi.RemoteException

Parameters:

groupId - - the groupId

objectId - - the objectId

Throws:

java.rmi.RemoteException

removeObject

void removeObject(java.lang.String groupId,
                  java.lang.String objectId)
                  throws java.rmi.RemoteException

Parameters:

groupId - - the groupId

objectId - - the objectId

infoObject - - the FILE that contains the information of the object.

Throws:

java.rmi.RemoteException

addGroup

java.lang.String addGroup(java.lang.String userId,
                          java.lang.String groupId,
                          GroupInfo groupInfo)
                          throws java.rmi.RemoteException

Parameters:

userId - - the userID provided by LaCOLLA.

groupId - - the new groupId (short version)

groupInfo - - the new groupInfo

Returns:

String - the new groupId (tyrex id + groupId)

Throws:

java.rmi.RemoteException

removeGroup

void removeGroup(java.lang.String userId,
                 java.lang.String groupId)
                 throws java.rmi.RemoteException

Parameters:

userId - - the userID provided by LaCOLLA.

groupId - - the groupId

Throws:

java.rmi.RemoteException

getInfoGroup

GroupInfo getInfoGroup(java.lang.String userId,
                       java.lang.String groupId,
                       java.lang.String aplicId)
                       throws java.rmi.RemoteException

Parameters:

userId - - the userID provided by LaCOLLA.

groupId - - the groupId

aplicId - - the application ID

Returns:

GroupInfo

Throws:

java.rmi.RemoteException

addMember

java.lang.String addMember(java.lang.String memberId,
                           java.lang.String groupId,
                           ObjectLaCOLLA memberInfo,
                           java.lang.String role,
                           java.lang.String username,
                           java.lang.String password,
                           java.lang.String emailAddress)
                           throws java.rmi.RemoteException

Parameters:

memberId - - the userID provided by LaCOLLA.

groupId - - the groupId

memberInfo - - an ObjectLaCOLLA associated with a member information file. This file will not be read by LaCOLLA; it contains information useful for the application only.

role - - the role of the member in the group {ROOT,USER,...}

username - - the username

password - - the password

emailAddress - - the email address of the new member

Returns:

String - the new memberID

Throws:

java.rmi.RemoteException

getInfoMember

void getInfoMember(ObjectLaCOLLA obj,
                   java.lang.String localPath)
                   throws java.rmi.RemoteException

Deprecated.

Parameters:

obj -

localPath -

Throws:

java.rmi.RemoteException

getInfoMember

ObjectLaCOLLA getInfoMember(java.lang.String memberId,
                            java.lang.String groupId,
                            java.lang.String localPath)
                            throws java.rmi.RemoteException

Parameters:

memberId -

groupId -

localPath. - Qualified filename where LaCOLLA will store the received bytes.

Returns:

LaColla.core.data.app.ObjectLaCOLLA

Throws:

java.rmi.RemoteException

sendInstantMessage

void sendInstantMessage(java.lang.String memberId,
                        java.lang.String groupId,
                        java.lang.Object message,
                        java.util.ArrayList targetList)
                        throws java.rmi.RemoteException

Parameters:

memberId - - the member identifier

groupId - - the groupId

message - - the message to be send

targetList - - the list of members to send the message to.

Throws:

java.rmi.RemoteException

submitTask

java.lang.String submitTask(byte[] xml,
                            java.lang.String groupId)
                            throws java.rmi.RemoteException

Parameters:

xml - - the task information

groupId - - the groupId

Returns:

String - the taskId

Throws:

java.rmi.RemoteException

stopTask

void stopTask(java.lang.String idTask,
              java.lang.String groupId)
              throws java.rmi.RemoteException

Parameters:

idTask - - the task identifier

groupId - - the groupId

Throws:

java.rmi.RemoteException

getTaskState

void getTaskState(java.lang.String idTask,
                  java.lang.String groupId)
                  throws java.rmi.RemoteException

Parameters:

idTask - - the task identifier

groupId - - the groupId

Throws:

java.rmi.RemoteException