com.day.crx.packaging

Interface PackageShare

public interface PackageShare

PackageShare...

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COOKIE_ID_NAME
static java.lang.String	PARAM_CLIENT_ID_NAME

Method Summary

Modifier and Type	Method and Description
PackageShareSession	getSession(HttpServletRequest req) Returns the session with the id provided with the cookie in the given request.
PackageShareSession	getSession(HttpServletRequest req, HttpServletResponse resp) Returns the session with the id provided with the cookie in the given request.
PackageShareSession	getSession(java.lang.String id) Returns the session of the given id.
PackageShareSession	login(Session session, HttpServletRequest req, HttpServletResponse resp, java.lang.String user, java.lang.String pass) Performs a login on the package share server.

Field Detail

COOKIE_ID_NAME

static final java.lang.String COOKIE_ID_NAME

See Also:

Constant Field Values

PARAM_CLIENT_ID_NAME

static final java.lang.String PARAM_CLIENT_ID_NAME

See Also:

Constant Field Values

Method Detail

getSession

PackageShareSession getSession(java.lang.String id)

Returns the session of the given id.

Parameters:

id - the id

Returns:

the session or null

getSession

PackageShareSession getSession(HttpServletRequest req)

Returns the session with the id provided with the cookie in the given request. returns null if no such cookie

Parameters:

req - the request

Returns:

the session or a anonymous session if not logged in yet.

getSession

PackageShareSession getSession(HttpServletRequest req,
                               HttpServletResponse resp)

Returns the session with the id provided with the cookie in the given request.

Parameters:

req - the request

resp - the response

Returns:

the session or a anonymous session if not logged in yet.

login

PackageShareSession login(Session session,
                          HttpServletRequest req,
                          HttpServletResponse resp,
                          java.lang.String user,
                          java.lang.String pass)
                   throws java.io.IOException

Performs a login on the package share server. when login is successful, the returned session is not anonymous. if connection failed, null is returned. otherwise the session data will have:

 {
 server: {
   host: "https://dev.day.com",
   message: "Welcome. Server Ready..."
 },
 user: {
   anonymous: false,
   userId: "tripod",
   name: "Toby",
   company: "Day"
 },
 shares: {
   day: {
     title: "Day",
     readOnly: false
   },
   ...
 }
 

Parameters:

session - jcr session

req - the request

resp - the response

user - user name

pass - pass word

Returns:

the session if successful or null if the login is invalid

Throws:

java.io.IOException - if there was an error during I/O with the server.