ContextualJson

The library considers context-aware JSON processing. It means that for every data processing it accepts current execution context containing, e.g., user's identity, application state, user's privileges, etc. This enables us to use these contextual data within conditions and transformations to provide/read only data matching these conditions.

Instances of ContextualJson implements the protocol and provides Reads and Writes materializers, including context type and implicit conversions. Everywhere we want to use the protocol we have to import everything from our protocol instance.

Example

Define the context

case class MyContext( requestId: Long )

Define the protocol

// optionally @play.api.json.protocol.removeNulls
// optionally @play.api.json.protocol.strict
object Protocol extends ContextualJson {

  override type Context = MyContext

  // space for further configuration, helpers, writes, reads, etc.
}

And then we import it everywhere we use the protocol

import Protocol._

&#64;protocol
case class Foo() {
   &#64;when( _.identity.hasPrivilege( "ADMIN" ) )
   var restricted: String = ""
}

Linear Supertypes

WritesMacro, ReadsMacro, Annotations, AbstractContext, AnyRef, Any

Type Members

abstract type Context

type of used context, e.g., MyContext.
type of used context, e.g., MyContext.
```
case class MyContext( identity: User )
```
Definition Classes
AbstractContext
trait ContextualReads[T <: context.ReadsMacro.Protocol] extends (context.ReadsMacro.Context) ⇒ Reads[T]

Context-aware Reads
Context-aware Reads

Definition Classes
ReadsMacro
trait ContextualWrites[T <: context.WritesMacro.Protocol, +Writes[_] <: Writes[_]] extends (context.WritesMacro.Context) ⇒ Writes[T]

Context-aware Writes
Context-aware Writes

Definition Classes
WritesMacro
trait Protocol extends AnyRef

markup trait marking classes for Reads/Writes materialization
markup trait marking classes for Reads/Writes materialization

Definition Classes
AbstractContext
class WriteTransformContext[T] extends AnyRef

encapsulates a Context with the processed instance
encapsulates a Context with the processed instance
Note: There is Any because we are unable to parametrize WriteContext[ T ] and use it within @when[ T ]. Scala would require manual providing [ T ] also when we do not need it. The solution would be to generate the type via macros, but annotation macro cannot be used within traits and it cannot be pulled out because it uses path-dependent Context type. In consequence, this falls back to Any and getter model[ T ], because of lack of support in macros.

Definition Classes
AbstractContext
case class WriteUpdateContext[+T] extends Product with Serializable

Definition Classes
AbstractContext
case class WriteWhenContext extends Product with Serializable

encapsulates a Context with the processed instance
encapsulates a Context with the processed instance
Note: There is Any because we are unable to parametrize WriteContext[ T ] and use it within @when[ T ]. Scala would require manual providing [ T ] also when we do not need it. The solution would be to generate the type via macros, but annotation macro cannot be used within traits and it cannot be pulled out because it uses path-dependent Context type. In consequence, this falls back to Any and getter model[ T ], because of lack of support in macros.

Definition Classes
AbstractContext

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
implicit val $protocol: ContextualJson.this.type
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object ContextualReads

set of helper functions used within ContextualReads macro to simplify the implementation
set of helper functions used within ContextualReads macro to simplify the implementation

Definition Classes
ReadsMacro
object WriteTransformContext

Definition Classes
AbstractContext
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
macro def contextlessReads[T <: Protocol]: Reads[T]

Definition Classes
ReadsMacro
macro def contextlessWrites[T <: Protocol]: Writes[T]

Definition Classes
WritesMacro
macro def contextualReads[T <: Protocol]: ContextualReads[T]

macro materializer of context-aware Reads
macro materializer of context-aware Reads

Definition Classes
ReadsMacro
macro def contextualWrites[T <: Protocol]: ContextualWrites[T, Writes]

macro materializer of context-aware Writes
macro materializer of context-aware Writes

Definition Classes
WritesMacro
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
object json

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit def reads[T <: Protocol](implicit context: Context, reads: ContextualReads[T]): Reads[T]

resolver of context-aware reads into regular reads.
resolver of context-aware reads into regular reads. Note: these resolved reads are valid only within given context!

Definition Classes
ReadsMacro
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit def unwrapWriteModelContext[T](context: WriteUpdateContext[T]): T

Definition Classes
AbstractContext
implicit def unwrapWriteTransformContext[T](context: WriteTransformContext[T]): T

Definition Classes
AbstractContext
implicit def unwrapWriteWhenContext(context: WriteWhenContext): Context

implicit helper to unwrap write context into regular context
implicit helper to unwrap write context into regular context

Definition Classes
AbstractContext
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( ... )
implicit def writes[T <: Protocol, Writes[_] <: Writes[_]](implicit context: Context, writes: ContextualWrites[T, Writes]): Writes[T]

resolver of context-aware writes into regular writes.
resolver of context-aware writes into regular writes. Note: these resolved writes are valid only within given context!

Definition Classes
WritesMacro

Related Doc: package json

trait ContextualJson extends AbstractContext with Annotations with ReadsMacro with WritesMacro

Example

Type Members

abstract type Context

trait ContextualReads[T <: context.ReadsMacro.Protocol] extends (context.ReadsMacro.Context) ⇒ Reads[T]

trait ContextualWrites[T <: context.WritesMacro.Protocol, +Writes[_] <: Writes[_]] extends (context.WritesMacro.Context) ⇒ Writes[T]

trait Protocol extends AnyRef

class WriteTransformContext[T] extends AnyRef

case class WriteUpdateContext[+T] extends Product with Serializable

case class WriteWhenContext extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

implicit val $protocol: ContextualJson.this.type

final def ==(arg0: Any): Boolean

object ContextualReads

object WriteTransformContext

final def asInstanceOf[T0]: T0

def clone(): AnyRef

macro def contextlessReads[T <: Protocol]: Reads[T]

macro def contextlessWrites[T <: Protocol]: Writes[T]

macro def contextualReads[T <: Protocol]: ContextualReads[T]

macro def contextualWrites[T <: Protocol]: ContextualWrites[T, Writes]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

object json

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def reads[T <: Protocol](implicit context: Context, reads: ContextualReads[T]): Reads[T]

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

def toString(): String

implicit def unwrapWriteModelContext[T](context: WriteUpdateContext[T]): T

implicit def unwrapWriteTransformContext[T](context: WriteTransformContext[T]): T

implicit def unwrapWriteWhenContext(context: WriteWhenContext): Context

final def wait(): Unit

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

final def wait(arg0: Long): Unit

implicit def writes[T <: Protocol, Writes[_] <: Writes[_]](implicit context: Context, writes: ContextualWrites[T, Writes]): Writes[T]

Inherited from WritesMacro

Inherited from ReadsMacro

Inherited from Annotations

Inherited from AbstractContext

Inherited from AnyRef

Inherited from Any

Ungrouped