com.rexsl.page.auth

Class AuthInset

java.lang.Object

com.rexsl.page.auth.AuthInset

All Implemented Interfaces:

Inset

@Loggable(value=1)
public final class AuthInset
extends Object
implements Inset

Authentication inset.

Since:

0.4.8

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

OAuth in RESTful Interfaces

Nested Class Summary

Nested classes/interfaces inherited from interface com.rexsl.page.Inset

Inset.Default, Inset.Runtime

Constructor Summary

Constructors

Constructor and Description
AuthInset(Resource res, String sec) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.NewCookie	cookie(Identity identity) Authentication cookie.
String	encrypt(Identity identity) Encrypt identity into text.
static String	encrypt(Identity identity, String key) Encrypt identity into text.
Identity	identity() Get user's identity (AuthException if not authenticated).
javax.ws.rs.core.NewCookie	logout() Logout authentication cookie.
void	render(BasePage<?,?> page, javax.ws.rs.core.Response.ResponseBuilder builder) Render it into the response builder.
AuthInset	with(Provider prov) With this authentication provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthInset

public AuthInset(@NotNull
         Resource res,
         @NotNull
         String sec)

Public ctor.

Parameters:

res - The resource

sec - Security key

Method Detail

encrypt

public static String encrypt(@NotNull
             Identity identity,
             @NotNull
             String key)

Encrypt identity into text.

Parameters:

identity - The identity to encrypt

key - Security key

Returns:

Encrypted text for cookie

encrypt

public String encrypt(@NotNull
             Identity identity)

Encrypt identity into text.

Parameters:

identity - The identity to encrypt

Returns:

Encrypted text for cookie

Since:

0.5

with

public AuthInset with(@NotNull
             Provider prov)

With this authentication provider.

Parameters:

prov - Additional authentication provider

Returns:

This object

identity

@Cacheable(lifetime=1,
           unit=SECONDS)
public Identity identity()

Get user's identity (AuthException if not authenticated).

Returns:

Identity, if authenticated

render

public void render(@NotNull
          BasePage<?,?> page,
          @NotNull
          javax.ws.rs.core.Response.ResponseBuilder builder)

Description copied from interface: Inset

Render it into the response builder.

Specified by:

render in interface Inset

Parameters:

page - The page to render

builder - The builder

cookie

public javax.ws.rs.core.NewCookie cookie(Identity identity)

Authentication cookie.

Parameters:

identity - The identity to wrap into the cookie

Returns:

The cookie

logout

@Cacheable.FlushAfter
public javax.ws.rs.core.NewCookie logout()

Logout authentication cookie.

Use this cookie to log user out of the system, for example:

 if (you_are_not_allowed()) {
   throw new AuthException(
     Response.seeOther(this.uriInfo().getBaseUri())
       .cookie(this.auth().logout())
       .build()
   );
 }
 

Returns:

The cookie