Package com.sun.enterprise.config.serverbeans

Interface ProviderConfig

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
public interface ProviderConfig extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
The provider-config element defines the configuration of an authentication provider.

A provider-config with no contained request-policy or response-policy sub-elements, is a null provider. The container will not instantiate or invoke the methods of a null provider, and as such the implementation class of a null provider need not exist.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROVIDER_TYPES
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    getClassName()
    Gets the value of the className property.
    List<org.jvnet.hk2.config.types.Property>
    getProperty()
    Properties.
    @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") @NotNull String
    getProviderId()
    Gets the value of the providerId property.
    @NotNull @Pattern(regexp="(client|server|client-server)",message="Valid values: (client|server|client-server)") String
    getProviderType()
    Gets the value of the providerType property.
    RequestPolicy
    getRequestPolicy()
    Gets the value of the requestPolicy property.
    ResponsePolicy
    getResponsePolicy()
    Gets the value of the responsePolicy property.
    void
    setClassName(String className)
    Sets the value of the className property.
    void
    setProviderId(String providerId)
    Sets the value of the providerId property.
    void
    setProviderType(String providerType)
    Sets the value of the providerType property.
    void
    setRequestPolicy(RequestPolicy requestPolicy)
    Sets the value of the requestPolicy property.
    void
    setResponsePolicy(ResponsePolicy responsePolicy)
    Sets the value of the responsePolicy property.

    Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

    createChild, deepCopy, getParent, getParent

    Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

    addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

  • Field Details

  • Method Details

    • getProviderId

      @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*", message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") @NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") @NotNull String getProviderId()
      Gets the value of the providerId property.

      Identifier used to uniquely identify this provider-config element.

      Returns:
      possible object is String

    • setProviderId

      void setProviderId(String providerId) throws PropertyVetoException
      Sets the value of the providerId property.
      Parameters:
      providerId - allowed object is String
      Throws:
      PropertyVetoException

    • getProviderType

      @NotNull @Pattern(regexp="(client|server|client-server)", message="Valid values: (client|server|client-server)") @NotNull @Pattern(regexp="(client|server|client-server)",message="Valid values: (client|server|client-server)") String getProviderType()
      Gets the value of the providerType property.

      Defines whether the provider is a client authentication provider or a server authentication provider.

      Returns:
      possible object is String

    • setProviderType

      void setProviderType(String providerType) throws PropertyVetoException
      Sets the value of the providerType property.
      Parameters:
      providerType - allowed object is String
      Throws:
      PropertyVetoException

    • getClassName

      @NotNull @JavaClassName @NotNull String getClassName()
      Gets the value of the className property.

      Defines the java implementation class of the provider.

      Client authentication providers must implement the com.sun.enterprise.security.jauth.ClientAuthModule interface. Server-side providers must implement the com.sun.enterprise.security.jauth.ServerAuthModule interface.

      A provider may implement both interfaces, but it must implement the interface corresponding to its provider type.

      Returns:
      possible object is String

    • setClassName

      void setClassName(String className) throws PropertyVetoException
      Sets the value of the className property.
      Parameters:
      className - allowed object is String
      Throws:
      PropertyVetoException

    • getRequestPolicy

      RequestPolicy getRequestPolicy()
      Gets the value of the requestPolicy property.

      Defines the authentication policy requirements associated with request processing performed by the authentication provider.

      Returns:
      possible object is RequestPolicy

    • setRequestPolicy

      void setRequestPolicy(RequestPolicy requestPolicy) throws PropertyVetoException
      Sets the value of the requestPolicy property.
      Parameters:
      requestPolicy - allowed object is RequestPolicy
      Throws:
      PropertyVetoException

    • getResponsePolicy

      ResponsePolicy getResponsePolicy()
      Gets the value of the responsePolicy property.

      Defines the authentication policy requirements associated with the response processing performed by the authentication provider.

      Returns:
      possible object is ResponsePolicy

    • setResponsePolicy

      void setResponsePolicy(ResponsePolicy responsePolicy) throws PropertyVetoException
      Sets the value of the responsePolicy property.
      Parameters:
      responsePolicy - allowed object is ResponsePolicy
      Throws:
      PropertyVetoException

    • getProperty

      @PropertyDesc(name="security.config",defaultValue="${com.sun.aas.instanceRoot}/config/wss-server-config-1.0.xml",description="Specifies the location of the message security configuration file") @PropertyDesc(name="debug",defaultValue="false",dataType=java.lang.Boolean.class,description="Enables dumping of server provider debug messages to the server log") @PropertyDesc(name="dynamic.username.password",defaultValue="false",dataType=java.lang.Boolean.class,description="Signals the provider runtime to collect the user name and password from the CallbackHandler for each request. If false, the user name and password for wsse:UsernameToken(s) is collected once, during module initialization. Applicable only for a ClientAuthModule") @PropertyDesc(name="encryption.key.alias",defaultValue="s1as",description="Specifies the encryption key used by the provider. The key is identified by its keystore alias") @PropertyDesc(name="signature.key.alias",defaultValue="s1as",description="Specifies the signature key used by the provider. The key is identified by its keystore alias") List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties.
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag