Package de.xima.fc.interfaces.auth

Interface IPluginView

All Superinterfaces:
Serializable
public interface IPluginView extends Serializable
Interface for plugin views. Plugin views define the availability & authorization requirements of the view. This interface may be expanded in the future to define, e.g. by URI resolver.
Since:
8.0.0
Author:
XIMA Media GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    IAuthorizer
    getAuthorizer()
    The authorizer determines if the currently signed-in user may access the view.
    IAvailabiltyResolver
    getStateResolver()
    The resolver checks if the view is available in the current state.

  • Method Details

    • getAuthorizer

      IAuthorizer getAuthorizer()
      The authorizer determines if the currently signed-in user may access the view. A custom authorizer may be defined or the de.xima.fc.security.authorization.AuthorizerFactory may be used. E.g. for simple client permission checks use: de.xima.fc.security.authorization.AuthorizerFactory#allClientPermissions(IAccessProperty...). Authorizers may be combined using de.xima.fc.security.authorization.AuthorizerFactory.and(IAuthorizer) and / or de.xima.fc.security.authorization.AuthorizerFactory.or(IAuthorizer).
      Returns:
      the authorizer that is used for checking the permissions of the currently signed-in user. If null is returned then the view is considered to be public, so every user is authorized to access the view.

    • getStateResolver

      IAvailabiltyResolver getStateResolver()
      The resolver checks if the view is available in the current state. A custom resolver may be defined or the de.xima.fc.security.endpoint.state.AvailabilityResolverFactory may be used. E.g. for checking if the client has a valid license use: de.xima.fc.security.endpoint.state.AvailabilityResolverFactory.validClientLic(). Resolvers may be combined using de.xima.fc.security.endpoint.state.AvailabilityResolverFactory.and(IAvailabilityResolver) and / or de.xima.fc.security.endpoint.state.AvailabilityResolverFactory.or(IAvailabilityResolver).
      Returns:
      the resolver that is used for checking the availability state of the view. If null is returned then the view is considered to be available in every state.