com.day.crx.packaging

Interface PackageShareSession

public interface PackageShareSession

PackageShareSession...

Method Summary

Modifier and Type	Method and Description
Proxy	createProxy(boolean suppressId) Returns a proxy to the package share server
java.util.Set<PackageInfo>	getAvailablePackages() Returns the packages the user of this session can access.
long	getCreationTime() Returns the time in milliseconds when this session was aquired.
java.lang.String	getId() Returns the id of this session
PackageShare	getService() Returns the package share service
JSONObject	getSessionInfo() Returns the JSON object of the session info provided by the server.
java.util.Set<java.lang.String>	getSharedGroups() Returns a list of groups this use is allowed to write
java.lang.String	getUserId() Returns the id of the user that own this session
java.lang.String	getUserName() Returns the name of the user
boolean	isAnonymous() Checks if this session is the anonymous session.
boolean	isNew() Checks if the session is new and never connected to the packageshare.
void	logout() Logs this session out and discards it from the session pool
JSONResponse	uploadPackage(java.io.File file, java.lang.String name, ProxyTracker tracker, java.lang.String group) Uploads a package to the package share
JSONResponse	uploadPackage(Node file, ProxyTracker tracker, java.lang.String group) Uploads a package to the package share

Method Detail

isAnonymous

boolean isAnonymous()

Checks if this session is the anonymous session.

Returns:

true if this session is the anonymous session

getService

PackageShare getService()

Returns the package share service

Returns:

the service

getId

java.lang.String getId()

Returns the id of this session

Returns:

the id.

getCreationTime

long getCreationTime()

Returns the time in milliseconds when this session was aquired.

Returns:

the creation time

isNew

boolean isNew()

Checks if the session is new and never connected to the packageshare.

Returns:

true if new.

getUserId

java.lang.String getUserId()

Returns the id of the user that own this session

Returns:

the user id

getUserName

java.lang.String getUserName()

Returns the name of the user

Returns:

the name

getSharedGroups

java.util.Set<java.lang.String> getSharedGroups()

Returns a list of groups this use is allowed to write

Returns:

list of groups

getAvailablePackages

java.util.Set<PackageInfo> getAvailablePackages()

Returns the packages the user of this session can access.

Returns:

the packages available.

getSessionInfo

JSONObject getSessionInfo()

Returns the JSON object of the session info provided by the server.

Returns:

the json object or null

logout

void logout()

Logs this session out and discards it from the session pool

createProxy

Proxy createProxy(boolean suppressId)

Returns a proxy to the package share server

Parameters:

suppressId - true to suppress automatic addition of the daypsid

Returns:

the proxy

uploadPackage

JSONResponse uploadPackage(Node file,
                           ProxyTracker tracker,
                           java.lang.String group)
                    throws java.io.IOException,
                           RepositoryException

Uploads a package to the package share

Parameters:

file - the file node

tracker - the tracker

group - desired package group

Returns:

the status response form the server

Throws:

java.io.IOException - if an error occurs

RepositoryException - if a repository error occurs

uploadPackage

JSONResponse uploadPackage(java.io.File file,
                           java.lang.String name,
                           ProxyTracker tracker,
                           java.lang.String group)
                    throws java.io.IOException,
                           RepositoryException

Uploads a package to the package share

Parameters:

file - the file

name - the name

tracker - the tracker

group - desired package group

Returns:

the status response form the server

Throws:

java.io.IOException - if an error occurs

RepositoryException - if a repository error occurs