Class AbstractEndpoint<T>

    • Constructor Detail

      • AbstractEndpoint

        public AbstractEndpoint​(String id)
        Create a new sensitive endpoint instance. The endpoint will enabled flag will be based on the spring Environment unless explicitly set.
        Parameters:
        id - the endpoint ID
      • AbstractEndpoint

        public AbstractEndpoint​(String id,
                                boolean sensitive)
        Create a new endpoint instance. The endpoint will enabled flag will be based on the spring Environment unless explicitly set.
        Parameters:
        id - the endpoint ID
        sensitive - if the endpoint is sensitive by default
      • AbstractEndpoint

        public AbstractEndpoint​(String id,
                                boolean sensitive,
                                boolean enabled)
        Create a new endpoint instance.
        Parameters:
        id - the endpoint ID
        sensitive - if the endpoint is sensitive
        enabled - if the endpoint is enabled or not.
    • Method Detail

      • getEnvironment

        protected final org.springframework.core.env.Environment getEnvironment()
      • setEnvironment

        public void setEnvironment​(org.springframework.core.env.Environment environment)
        Specified by:
        setEnvironment in interface org.springframework.context.EnvironmentAware
      • getId

        public String getId()
        Description copied from interface: Endpoint
        The logical ID of the endpoint. Must only contain simple letters, numbers and '_' characters (i.e. a "\w" regex).
        Specified by:
        getId in interface Endpoint<T>
        Returns:
        the endpoint ID
      • isEnabled

        public boolean isEnabled()
        Description copied from interface: Endpoint
        Return if the endpoint is enabled.
        Specified by:
        isEnabled in interface Endpoint<T>
        Returns:
        if the endpoint is enabled
      • isSensitive

        public boolean isSensitive()
        Description copied from interface: Endpoint
        Return if the endpoint is sensitive, i.e. may return data that the average user should not see. Mappings can use this as a security hint.
        Specified by:
        isSensitive in interface Endpoint<T>
        Returns:
        if the endpoint is sensitive