PathParam

Abstract away the complexity of boxing/unboxing param values for locations that should be available for things like autologin. By default, a location is undefined if its value cannot be determined. When a user is not logged in, the param's value may not be available because we use the current user's session information for data retrieval. We work around this by providing a simplified data lookup for non-logged in users and then authenticate the data once the user has logged in.

The flip-side to this is that there is an additional method that must be included on the snippets that use the location's parameter(s).

func: Function for retrieving the value of the Param based on the current user's authentication status
auth: Check that user has access to the param value.

See also: net.amullins.liftkit.routing.params.PathParamAuth

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new PathParam(func: PartialFunction[Boolean, Box[ParamType]], auth: (ParamType) ⇒ Boolean)(implicit paramTypeTag: scala.reflect.api.JavaUniverse.TypeTag[ParamType])

func
Function for retrieving the value of the Param based on the current user's authentication status
auth
Check that user has access to the param value.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val auth: (ParamType) ⇒ Boolean

Check that user has access to the param value.
def boxed: Box[Box[PathParam[ParamType]]]

This is for use with Menu.param(s) parser If the value is NOT Full, the location will be unavailable
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val func: PartialFunction[Boolean, Box[ParamType]]

Function for retrieving the value of the Param based on the current user's authentication status
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def get_?: Box[ParamType]

Performs authentication on the value according to the provided auth function
Performs authentication on the value according to the provided auth function
returns
The boxed value Full, if accessible | Empty, if not
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit val paramTypeTag: scala.reflect.api.JavaUniverse.TypeTag[ParamType]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val value: Box[ParamType]

This is the *actual* value of the param
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

case class PathParam[ParamType](func: PartialFunction[Boolean, Box[ParamType]], auth: (ParamType) ⇒ Boolean)(implicit paramTypeTag: scala.reflect.api.JavaUniverse.TypeTag[ParamType]) extends Product with Serializable

Instance Constructors

new PathParam(func: PartialFunction[Boolean, Box[ParamType]], auth: (ParamType) ⇒ Boolean)(implicit paramTypeTag: scala.reflect.api.JavaUniverse.TypeTag[ParamType])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val auth: (ParamType) ⇒ Boolean

def boxed: Box[Box[PathParam[ParamType]]]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val func: PartialFunction[Boolean, Box[ParamType]]

final def getClass(): Class[_]

def get_?: Box[ParamType]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val paramTypeTag: scala.reflect.api.JavaUniverse.TypeTag[ParamType]

final def synchronized[T0](arg0: ⇒ T0): T0

val value: Box[ParamType]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped