com.lightbend.lagom.javadsl.api.security

Interface ServicePrincipal

All Superinterfaces:

Principal

public interface ServicePrincipal
extends Principal

A service principal.

A service principal may either represent a service identity, or it may be a principal that a service made a request on behalf of.

Method Summary

Modifier and Type	Method and Description
default boolean	authenticated() Whether the service was authenticated.
static ServicePrincipal	forServiceNamed(String serviceName) Get a service principal for the given named service.
default String	serviceName() The service name.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Method Detail

serviceName

default String serviceName()

The service name.

This may or may not be the same as Principal.getName(), depending on whether the principal represents the service itself, or simply a request made by the service on behalf of another principal.

Returns:

The server name.

authenticated

default boolean authenticated()

Whether the service was authenticated.

Some service identity strategies simply pull the service name from a header, which can be trivially spoofed. This can be used to distinguish whether the service identity has been established by an insecure means such as that, or a secure means such as client certificates, signed tokens or shared secrets.

Returns:

True if the service identity was established by some secure means.

forServiceNamed

static ServicePrincipal forServiceNamed(String serviceName)

Get a service principal for the given named service.

Returns:

The service principal.