org.xiruss.xirussrepository.client
Class XirussHttpApiClientHelper

java.lang.Object
  org.xiruss.xirussrepository.client.XirussHttpApiClientHelper

public class XirussHttpApiClientHelper
extends java.lang.Object

Helper class for using the XIRUSS-T HTTP REST API.

Constructor Summary

XirussHttpApiClientHelper(java.lang.String host, int port)

Method Summary

java.net.HttpURLConnection	commitSnapshot(java.lang.String branchId, java.lang.String snapId, java.lang.String userId)
java.net.HttpURLConnection	commitSnapshot(java.lang.String branchId, java.lang.String snapId, java.lang.String userId, java.lang.String parms)
VersionByResourceMap	constructVersionByResourceMap(Repository rep, org.w3c.dom.Element elem) Takes a version_list element and uses it to populate a version-to-resource map
Branch	createBranch(java.lang.String branchName)
Branch	createBranch(java.lang.String branchName, java.lang.String parms)
java.net.HttpURLConnection	createDependency(java.lang.String branchId, java.lang.String snapId, java.lang.String verId, java.lang.String resId, java.lang.String userId)
java.net.HttpURLConnection	createDependency(java.lang.String branchId, java.lang.String snapId, java.lang.String verId, java.lang.String resId, java.lang.String userId, java.lang.String depClassName, java.lang.String parms)
MutableSnapshot	createMutableSnapshot(Branch br)
MutableSnapshot	createMutableSnapshot(Branch br, java.lang.String parms)
java.net.HttpURLConnection	createNewSnapshot(java.lang.String branchId, java.lang.String snapName)
java.net.HttpURLConnection	createNewSnapshot(java.lang.String branchId, java.lang.String snapName, java.lang.String parms)
Resource	createResource(java.lang.String resName)
Resource	createResource(java.lang.String resName, java.lang.String parms)
java.io.InputStream	createUser(java.lang.String userName)
java.io.InputStream	createUser(java.lang.String userName, java.lang.String parms)
java.io.InputStream	doGet(PathString path)
java.io.InputStream	doGet(java.lang.String path)
java.net.HttpURLConnection	doPost(java.lang.String path)
java.net.HttpURLConnection	doPut(PathString path)
void	endSession(java.lang.String sessionId)
boolean	getBooleanResult(java.lang.String path)
Branch	getBranch(java.lang.String objId)
java.util.Map	getBranches()
long	getCountValue(PathString path)
XirussRepository	getRepository()
(package private) Resource	getResource(java.lang.String objId)
java.io.InputStream	getSession(User user)
Session	getSessionForUser(java.lang.String objId)
Snapshot	getSnapshot(java.lang.String snapId) Get a snapshot without regard to branch context
java.lang.String	getStringResult(PathString path)
User	getUser(java.lang.String objId)
VersionByResourceMap	getVBRMapValue(PathString path)
VersionMap	getVersionMapValue(PathString path)
org.w3c.dom.Document	getXmlGetResult(PathString path)
org.w3c.dom.Document	getXmlResult(java.io.InputStream resultMessageStream)
boolean	repositoryIsAvailable()
java.net.HttpURLConnection	setVersionProperty(java.lang.String branchId, java.lang.String snapId, java.lang.String verId, java.lang.String userId, java.lang.String propName, java.lang.String propValue, java.lang.String parms)

Methods inherited from class java.lang.Object

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

Constructor Detail

XirussHttpApiClientHelper

public XirussHttpApiClientHelper(java.lang.String host,
                                 int port)

Method Detail

createUser

public java.io.InputStream createUser(java.lang.String userName,
                                      java.lang.String parms)
                               throws java.io.IOException

Throws:

java.io.IOException

createBranch

public Branch createBranch(java.lang.String branchName)
                    throws java.io.IOException

Throws:

java.io.IOException

createBranch

public Branch createBranch(java.lang.String branchName,
                           java.lang.String parms)
                    throws java.io.IOException

Throws:

java.io.IOException

createResource

public Resource createResource(java.lang.String resName,
                               java.lang.String parms)
                        throws java.io.IOException

Throws:

java.io.IOException

getResource

Resource getResource(java.lang.String objId)
               throws java.io.IOException

Throws:

java.io.IOException

createNewSnapshot

public java.net.HttpURLConnection createNewSnapshot(java.lang.String branchId,
                                                    java.lang.String snapName,
                                                    java.lang.String parms)
                                             throws java.io.IOException

Throws:

java.io.IOException

commitSnapshot

public java.net.HttpURLConnection commitSnapshot(java.lang.String branchId,
                                                 java.lang.String snapId,
                                                 java.lang.String userId,
                                                 java.lang.String parms)
                                          throws java.io.IOException

Throws:

java.io.IOException

createDependency

public java.net.HttpURLConnection createDependency(java.lang.String branchId,
                                                   java.lang.String snapId,
                                                   java.lang.String verId,
                                                   java.lang.String resId,
                                                   java.lang.String userId,
                                                   java.lang.String depClassName,
                                                   java.lang.String parms)
                                            throws java.io.IOException

Throws:

java.io.IOException

setVersionProperty

public java.net.HttpURLConnection setVersionProperty(java.lang.String branchId,
                                                     java.lang.String snapId,
                                                     java.lang.String verId,
                                                     java.lang.String userId,
                                                     java.lang.String propName,
                                                     java.lang.String propValue,
                                                     java.lang.String parms)
                                              throws java.io.IOException

Throws:

java.io.IOException

doPut

public java.net.HttpURLConnection doPut(PathString path)
                                 throws java.io.IOException

Throws:

java.io.IOException

doPost

public java.net.HttpURLConnection doPost(java.lang.String path)
                                  throws java.io.IOException

Throws:

java.io.IOException

doGet

public java.io.InputStream doGet(java.lang.String path)
                          throws java.io.IOException

Throws:

java.io.IOException

createUser

public java.io.InputStream createUser(java.lang.String userName)
                               throws java.io.IOException

Throws:

java.io.IOException

createNewSnapshot

public java.net.HttpURLConnection createNewSnapshot(java.lang.String branchId,
                                                    java.lang.String snapName)
                                             throws java.io.IOException

Throws:

java.io.IOException

commitSnapshot

public java.net.HttpURLConnection commitSnapshot(java.lang.String branchId,
                                                 java.lang.String snapId,
                                                 java.lang.String userId)
                                          throws java.io.IOException

Throws:

java.io.IOException

createResource

public Resource createResource(java.lang.String resName)
                        throws java.io.IOException

Throws:

java.io.IOException

createDependency

public java.net.HttpURLConnection createDependency(java.lang.String branchId,
                                                   java.lang.String snapId,
                                                   java.lang.String verId,
                                                   java.lang.String resId,
                                                   java.lang.String userId)
                                            throws java.io.IOException

Throws:

java.io.IOException

repositoryIsAvailable

public boolean repositoryIsAvailable()
                              throws java.lang.Throwable

Throws:

java.lang.Throwable

getRepository

public XirussRepository getRepository()
                               throws XirussRepositoryException

Throws:

XirussRepositoryException

getXmlResult

public org.w3c.dom.Document getXmlResult(java.io.InputStream resultMessageStream)
                                  throws java.io.IOException

Throws:

java.io.IOException

getSession

public java.io.InputStream getSession(User user)
                               throws java.io.IOException

Throws:

java.io.IOException

getUser

public User getUser(java.lang.String objId)
             throws java.io.IOException

Throws:

java.io.IOException

getSessionForUser

public Session getSessionForUser(java.lang.String objId)
                          throws java.io.IOException

Throws:

java.io.IOException

endSession

public void endSession(java.lang.String sessionId)

getBranches

public java.util.Map getBranches()
                          throws java.io.IOException

Throws:

java.io.IOException

createMutableSnapshot

public MutableSnapshot createMutableSnapshot(Branch br)
                                      throws java.io.IOException

Throws:

java.io.IOException

createMutableSnapshot

public MutableSnapshot createMutableSnapshot(Branch br,
                                             java.lang.String parms)
                                      throws java.io.IOException

Throws:

java.io.IOException

getSnapshot

public Snapshot getSnapshot(java.lang.String snapId)
                     throws java.io.IOException

Get a snapshot without regard to branch context

Parameters:

snapId -

Returns:

Throws:

java.io.IOException

getBranch

public Branch getBranch(java.lang.String objId)
                 throws java.io.IOException

Throws:

java.io.IOException

constructVersionByResourceMap

public VersionByResourceMap constructVersionByResourceMap(Repository rep,
                                                          org.w3c.dom.Element elem)
                                                   throws java.io.IOException

Takes a version_list element and uses it to populate a version-to-resource map

Parameters:

elem - version_list element that lists zero or more versions.

Returns:

Throws:

java.io.IOException

getVBRMapValue

public VersionByResourceMap getVBRMapValue(PathString path)

getVersionMapValue

public VersionMap getVersionMapValue(PathString path)

getCountValue

public long getCountValue(PathString path)
                   throws java.io.IOException

Throws:

java.io.IOException

getBooleanResult

public boolean getBooleanResult(java.lang.String path)
                         throws java.io.IOException

Throws:

java.io.IOException

getStringResult

public java.lang.String getStringResult(PathString path)
                                 throws java.io.IOException

Throws:

java.io.IOException

doGet

public java.io.InputStream doGet(PathString path)
                          throws java.io.IOException

Throws:

java.io.IOException

getXmlGetResult

public org.w3c.dom.Document getXmlGetResult(PathString path)
                                     throws java.io.IOException

Throws:

java.io.IOException