Package org.cyclos.impl.access

Class SessionDataFactory

java.lang.Object

org.cyclos.impl.access.SessionDataFactory

public class SessionDataFactory
extends Object

Any session data must be obtained using this factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionDataFactory.DirectSessionDataBuilder

Constructor Summary

Constructors

Constructor	Description
SessionDataFactory()

Method Summary

Modifier and Type	Method	Description
static SessionData	accessClient(boolean forLogin, String channel, String token, RequestData data)
static SessionDataFactory.DirectSessionDataBuilder	direct(BasicUser user)	Returns a builder for a user session data with the username as principal, by default ignoring urgent situations.
static SessionDataFactory.DirectSessionDataBuilder	direct(UserPrincipal principal)	Returns a builder for a user session data with the given principal, by default ignoring urgent situations.
static SessionData	guest(RequestData requestData, String channel)
static SessionData	guest(RequestData requestData, String channel, String accessChannelName)
static SessionData	inChannel(String channelName)	Returns a new SessionData inheriting the current invocation's session data but for the given channel.
static SessionData	oidc(String accessToken, RequestData requestData)
static SessionData	script(boolean runAsSystem)
static SessionData	script(SessionData delegate, boolean runAsSystem)
static SessionData	stateful(String sessionToken, String remoteAddress, RequestData requestData)
static SessionData	stateful(Session session, RequestData requestData)
static SessionData	stateless(boolean forLogin, boolean allowIfPwdExpired, String channelName, String principalType, String principal, String password, RequestData requestData)
static SessionData	system()	Returns a SystemSessionData inheriting the current invocation's request data and channel. If there is no current InvocationContext, assumes a local request in the main channel. This method is intended to gain system privileges when running in a network or in global mode.
static SessionData	system(Network network)
static SessionData	system(Network network, String channel)	Returns a SystemSessionData inheriting the current invocation's request data and channel. This method is intended to switch to the given network and gain system privileges. If the given network is null then it works same as system().
static SessionData	system(RequestData data)
static SessionData	system(RequestData data, String channel)
static SessionData	system(RequestData data, String channel, String accessChannel)
static SessionData	user(BasicUser user)	Builds a session data for the given user, ignoring all urgent situations
static SessionData	user(UserPrincipal principal)	Builds a session data for the given user principal, ignoring all urgent situations

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionDataFactory

public SessionDataFactory()

Method Detail

accessClient

public static SessionData accessClient(boolean forLogin,
                                       String channel,
                                       String token,
                                       RequestData data)

direct

public static SessionDataFactory.DirectSessionDataBuilder direct(BasicUser user)

Returns a builder for a user session data with the username as principal, by default ignoring urgent situations.

direct

public static SessionDataFactory.DirectSessionDataBuilder direct(UserPrincipal principal)

Returns a builder for a user session data with the given principal, by default ignoring urgent situations.

guest

public static SessionData guest(RequestData requestData,
                                String channel)

guest

public static SessionData guest(RequestData requestData,
                                String channel,
                                String accessChannelName)

inChannel

public static SessionData inChannel(String channelName)

Returns a new SessionData inheriting the current invocation's session data but for the given channel. If the channel is null or the current session is already for the given channel then just return the current one.

oidc

public static SessionData oidc(String accessToken,
                               RequestData requestData)

script

public static SessionData script(boolean runAsSystem)

script

public static SessionData script(SessionData delegate,
                                 boolean runAsSystem)

stateful

public static SessionData stateful(Session session,
                                   RequestData requestData)

stateful

public static SessionData stateful(String sessionToken,
                                   String remoteAddress,
                                   RequestData requestData)

stateless

public static SessionData stateless(boolean forLogin,
                                    boolean allowIfPwdExpired,
                                    String channelName,
                                    String principalType,
                                    String principal,
                                    String password,
                                    RequestData requestData)

system

public static SessionData system()

Returns a SystemSessionData inheriting the current invocation's request data and channel.
If there is no current InvocationContext, assumes a local request in the main channel.
This method is intended to gain system privileges when running in a network or in global mode. If you want to switch to a network then use system(Network).

system

public static SessionData system(Network network)
                          throws IllegalStateException

Throws:

IllegalStateException

See Also:

system(Network, String)

system

public static SessionData system(Network network,
                                 String channel)
                          throws IllegalStateException

Returns a SystemSessionData inheriting the current invocation's request data and channel.
This method is intended to switch to the given network and gain system privileges.
If the given network is null then it works same as system(). i.e just gaining systen privileges

Throws:

IllegalStateException - If there is no current InvocationContext and the network is not null

system

public static SessionData system(RequestData data)

system

public static SessionData system(RequestData data,
                                 String channel)

system

public static SessionData system(RequestData data,
                                 String channel,
                                 String accessChannel)

user

public static SessionData user(BasicUser user)

Builds a session data for the given user, ignoring all urgent situations

user

public static SessionData user(UserPrincipal principal)

Builds a session data for the given user principal, ignoring all urgent situations