Package org.rapidcontext.app.proc

Class SessionAuthenticateProcedure

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.type.Procedure

org.rapidcontext.app.proc.SessionAuthenticateProcedure

public class SessionAuthenticateProcedure
extends Procedure

The built-in session authentication procedure.

Version:

1.0

Field Summary

Fields inherited from class org.rapidcontext.core.type.Procedure

ACTIVE_MILLIS, KEY_ALIAS, KEY_BINDING, KEY_DEPRECATED, KEY_DESCRIPTION, PATH

Fields inherited from class org.rapidcontext.core.storage.StorableObject

dict, KEY_ACTIVATED_TIME, KEY_CLASSNAME, KEY_ID, KEY_TYPE, PREFIX_COMPUTED, PREFIX_HIDDEN

Constructor Summary

Constructors

Constructor	Description
SessionAuthenticateProcedure(String id, String type, Dict dict)	Creates a new procedure from a serialized representation.

Method Summary

Modifier and Type	Method	Description
Object	call(CallContext cx, Bindings bindings)	Executes a call of this procedure in the specified context and with the specified call bindings.
static Dict	response(boolean success, String message, String userId)	Builds an authentication response object.

Methods inherited from class org.rapidcontext.core.type.Procedure

alias, all, deprecated, description, find, getBindings, isActive, metrics, normalize, refreshAliases, report

Methods inherited from class org.rapidcontext.core.storage.StorableObject

activate, activatedTime, destroy, dictKey, id, init, isModified, passivate, path, serialize, sterilize, toString, type

Methods inherited from class java.lang.Object

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

Constructor Details

SessionAuthenticateProcedure

public SessionAuthenticateProcedure(String id,
 String type,
 Dict dict)

Creates a new procedure from a serialized representation.

Parameters:

id - the object identifier

type - the object type name

dict - the serialized representation

Method Details

call

public Object call(CallContext cx,
 Bindings bindings)
            throws ProcedureException

Executes a call of this procedure in the specified context and with the specified call bindings. The semantics of what the procedure actually does, is up to each implementation. Note that the call bindings are normally inherited from the procedure bindings with arguments bound to their call values.

Specified by:

call in class Procedure

Parameters:

cx - the procedure call context

bindings - the call bindings to use

Returns:

the result of the call, or null if the call produced no result

Throws:

ProcedureException - if the call execution caused an error

response

public static Dict response(boolean success,
 String message,
 String userId)

Builds an authentication response object.

Parameters:

success - the authentication success flag

message - the success or error message

userId - the user identifier, or null

Returns:

the authentication response object