|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EMFStore
An EMF store is responsible for storing projects, change management on projects and for persisting projects.
Field Summary | |
---|---|
static org.eclipse.emf.common.util.URI |
CHANGEPACKAGE_URI
Virtual URI for change package de-/serialization. |
static org.eclipse.emf.common.util.URI |
PROJECT_URI
Virtual URI for project de-/serialization. |
Method Summary | |
---|---|
void |
addTag(SessionId sessionId,
ProjectId projectId,
PrimaryVersionSpec versionSpec,
TagVersionSpec tag)
Adds a tag to a version of the specified project. |
ProjectInfo |
createEmptyProject(SessionId sessionId,
String name,
String description,
LogMessage logMessage)
Create a new project on the server. |
ProjectInfo |
createProject(SessionId sessionId,
String name,
String description,
LogMessage logMessage,
Project project)
Create a new project on the server. |
PrimaryVersionSpec |
createVersion(SessionId sessionId,
ProjectId projectId,
PrimaryVersionSpec baseVersionSpec,
ChangePackage changePackage,
BranchVersionSpec targetBranch,
PrimaryVersionSpec sourceVersion,
LogMessage logMessage)
Create a new version on the server of the given project. |
void |
deleteProject(SessionId sessionId,
ProjectId projectId,
boolean deleteFiles)
Deletes a project on the server. |
FileChunk |
downloadFileChunk(SessionId sessionId,
ProjectId projectId,
FileTransferInformation fileInformation)
Downloads a file chunk from the server. |
ProjectHistory |
exportProjectHistoryFromServer(SessionId sessionId,
ProjectId projectId)
Exports a given project history from the server. |
List<BranchInfo> |
getBranches(SessionId sessionId,
ProjectId projectId)
Lista all branches of the given project. |
List<ChangePackage> |
getChanges(SessionId sessionId,
ProjectId projectId,
VersionSpec source,
VersionSpec target)
Get changes from the server. |
List<EMFStoreProperty> |
getEMFProperties(SessionId sessionId,
ProjectId projectId)
Get stored EMFStoreProperties from the server. |
List<HistoryInfo> |
getHistoryInfo(SessionId sessionId,
ProjectId projectId,
HistoryQuery<?> historyQuery)
Get history information from the server. |
Project |
getProject(SessionId sessionId,
ProjectId projectId,
VersionSpec versionSpec)
Gets a project in a certain revision from the server. |
List<ProjectInfo> |
getProjectList(SessionId sessionId)
Get a list of projects the user of the session id can access. |
String |
getVersion(SessionId sessionId)
Returns the version of the EMFStore server. |
ProjectId |
importProjectHistoryToServer(SessionId sessionId,
ProjectHistory projectHistory)
Imports a project history to the server. |
void |
registerEPackage(SessionId sessionId,
org.eclipse.emf.ecore.EPackage pkg)
Register a new EPackage. |
void |
removeTag(SessionId sessionId,
ProjectId projectId,
PrimaryVersionSpec versionSpec,
TagVersionSpec tag)
Removes a tag to a version of the specified project. |
ACUser |
resolveUser(SessionId sessionId,
ACOrgUnitId id)
Resolves a user by id and returns an ACUser with all roles on the server. |
PrimaryVersionSpec |
resolveVersionSpec(SessionId sessionId,
ProjectId projectId,
VersionSpec versionSpec)
Resolve a version specified to a primary version specifier. |
List<EMFStoreProperty> |
setEMFProperties(SessionId sessionId,
List<EMFStoreProperty> property,
ProjectId projectId)
Store EMFProperties on the server. |
void |
transmitProperty(SessionId sessionId,
OrgUnitProperty changedProperty,
ACUser tmpUser,
ProjectId projectId)
|
FileTransferInformation |
uploadFileChunk(SessionId sessionId,
ProjectId projectId,
FileChunk fileChunk)
Uploads a file chunk to the server. |
Field Detail |
---|
static final org.eclipse.emf.common.util.URI CHANGEPACKAGE_URI
static final org.eclipse.emf.common.util.URI PROJECT_URI
Method Detail |
---|
List<ProjectInfo> getProjectList(SessionId sessionId) throws ESException
sessionId
- the session id for authentication
ESException
- if any error in the EmfStore occursProject getProject(SessionId sessionId, ProjectId projectId, VersionSpec versionSpec) throws ESException
sessionId
- the session id for authenticationprojectId
- the project id of the project to getversionSpec
- the version to get
ESException
- if any error in the EmfStore occursServerConfiguration.PROJECTSTATE_VERSION_PERSISTENCE
PrimaryVersionSpec createVersion(SessionId sessionId, ProjectId projectId, PrimaryVersionSpec baseVersionSpec, ChangePackage changePackage, BranchVersionSpec targetBranch, PrimaryVersionSpec sourceVersion, LogMessage logMessage) throws ESException, InvalidVersionSpecException
sessionId
- the session id for authenticationprojectId
- the project idbaseVersionSpec
- the version the project was last synched with the serverchangePackage
- the changes performed on the project since last synchtargetBranch
- this should be set if a new branch shout be created with this
commit. Otherwise set nullsourceVersion
- if a branch was merged and the resulting merged changed are
committed this should be set to the incoming branch inorder to
set correct links in the version model. Can be null otherwiselogMessage
- the log message for the new version
InvalidVersionSpecException
- if the base version is not equal to the current head
revision.
ESException
- if any error in the EmfStore occursPrimaryVersionSpec resolveVersionSpec(SessionId sessionId, ProjectId projectId, VersionSpec versionSpec) throws ESException
sessionId
- the session id for authenticationversionSpec
- the version specifier to resolveprojectId
- the project id
ESException
- if any error in the EmfStore occursList<ChangePackage> getChanges(SessionId sessionId, ProjectId projectId, VersionSpec source, VersionSpec target) throws ESException
sessionId
- the session id for authenticationprojectId
- the project idsource
- the source version specifiertarget
- the target version specifier
ESException
- if any error in the EmfStore occursList<BranchInfo> getBranches(SessionId sessionId, ProjectId projectId) throws ESException
sessionId
- the session id for authenticationprojectId
- the project id
BranchInfo
ESException
- in case of an errorList<HistoryInfo> getHistoryInfo(SessionId sessionId, ProjectId projectId, HistoryQuery<?> historyQuery) throws ESException
HistoryQuery
.
sessionId
- the session idprojectId
- the project idhistoryQuery
- the historyQuery
ESException
- if any error in the EmfStore occursvoid addTag(SessionId sessionId, ProjectId projectId, PrimaryVersionSpec versionSpec, TagVersionSpec tag) throws ESException
sessionId
- the session idprojectId
- the project idversionSpec
- the version versionSpectag
- the tag
ESException
- if any error in the EmfStore occursvoid removeTag(SessionId sessionId, ProjectId projectId, PrimaryVersionSpec versionSpec, TagVersionSpec tag) throws ESException
sessionId
- the session idprojectId
- the project idversionSpec
- the version versionSpectag
- the tag to be removed
ESException
- if any error in the EmfStore occursProjectInfo createEmptyProject(SessionId sessionId, String name, String description, LogMessage logMessage) throws ESException
sessionId
- the session id for authenticationname
- the name of the serverdescription
- the descriptionlogMessage
- the logMessage
ProjectInfo
for the new project
ESException
- if any error in the EmfStore occursProjectInfo createProject(SessionId sessionId, String name, String description, LogMessage logMessage, Project project) throws ESException
sessionId
- the session id for authenticationname
- the name of the serverdescription
- the descriptionlogMessage
- the logMessageproject
- the initial project state
ProjectInfo
for the new project
ESException
- if any error in the EmfStore occursvoid deleteProject(SessionId sessionId, ProjectId projectId, boolean deleteFiles) throws ESException
sessionId
- the session idprojectId
- the project iddeleteFiles
- if true, the project files will be deleted too
ESException
- in case of failureACUser resolveUser(SessionId sessionId, ACOrgUnitId id) throws ESException
sessionId
- session idid
- user id, can be null, then requesting user gets resolved
ESException
- if any error in the EmfStore occursProjectId importProjectHistoryToServer(SessionId sessionId, ProjectHistory projectHistory) throws ESException
sessionId
- sessionidprojectHistory
- project history
ESException
- in case of failureProjectHistory exportProjectHistoryFromServer(SessionId sessionId, ProjectId projectId) throws ESException
sessionId
- session idprojectId
- project id
ESException
- in case of failureFileTransferInformation uploadFileChunk(SessionId sessionId, ProjectId projectId, FileChunk fileChunk) throws ESException
sessionId
- session idprojectId
- project idfileChunk
- file chunk
ESException
- if any error occurs in the EmfStoreFileChunk downloadFileChunk(SessionId sessionId, ProjectId projectId, FileTransferInformation fileInformation) throws ESException
sessionId
- session idprojectId
- project idfileInformation
- file information
ESException
- if any error occurs in the EmfStorevoid transmitProperty(SessionId sessionId, OrgUnitProperty changedProperty, ACUser tmpUser, ProjectId projectId) throws ESException
sessionId
- session idchangedProperty
- the property that has been changed client-sidetmpUser
- the respective userprojectId
- the project id
ESException
- if any error occurs in the EmfStoreList<EMFStoreProperty> setEMFProperties(SessionId sessionId, List<EMFStoreProperty> property, ProjectId projectId) throws ESException
sessionId
- sessionIdproperty
- list properties which shall be shared on the server.projectId
- the project id
ESException
- if any error occurs in the EmfStoreList<EMFStoreProperty> getEMFProperties(SessionId sessionId, ProjectId projectId) throws ESException
sessionId
- sessionIdprojectId
- the projct id
ESException
- if any error occurs in the EmfStorevoid registerEPackage(SessionId sessionId, org.eclipse.emf.ecore.EPackage pkg) throws ESException
sessionId
- session idpkg
- the EPackage to be registered
ESException
- if any error occurs in the EmfStoreString getVersion(SessionId sessionId) throws ESException
sessionId
- a session ID
ESException
- in case of an error
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |