Interface MessageSecurityConfig

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy

public interface MessageSecurityConfig extends org.jvnet.hk2.config.ConfigBeanProxy
Defines the message layer specific provider configurations of the application server.

All the providers within a message-security-config element must be able to perform authentication processing at the message layer defined by the value of the auth-layer attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    Gets the value of the authLayer property.
    @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") String
    Gets the value of the defaultClientProvider property.
    @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*",message="Pattern: [A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") String
    Gets the value of the defaultProvider property.
    Gets the value of the providerConfig property.
    void
    setAuthLayer(String authLayer)
    Sets the value of the authLayer property.
    void
    setDefaultClientProvider(String defaultClientProvider)
    Sets the value of the defaultClientProvider property.
    void
    setDefaultProvider(String defaultProvider)
    Sets the value of the defaultProvider property.

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

    createChild, deepCopy, getParent, getParent
  • Method Details

    • getAuthLayer

      @NotNull @NotNull String getAuthLayer()
      Gets the value of the authLayer property. Values: SOAP or HttpServlet.

      All the providers within a message-security-config element must be able to perform authentication processing at the message layer defined by the value of the auth-layer attribute.

      Returns:
      possible object is String
    • setAuthLayer

      void setAuthLayer(String authLayer) throws PropertyVetoException
      Sets the value of the authLayer property.
      Parameters:
      authLayer - allowed object is String
      Throws:
      PropertyVetoException
    • getDefaultProvider

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

      Used to identify the server provider to be invoked for any application for which a specific server provider has not been bound.

      When a default provider of a type is not defined for a message layer, the container will only invoke a provider of the type (at the layer) for those applications for which a specific provider has been bound.

      Returns:
      possible object is String
    • setDefaultProvider

      void setDefaultProvider(String defaultProvider) throws PropertyVetoException
      Sets the value of the defaultProvider property.
      Parameters:
      defaultProvider - allowed object is String
      Throws:
      PropertyVetoException
    • getDefaultClientProvider

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

      Used to identify the client provider to be invoked for any application for which a specific client provider has not been bound.

      Returns:
      possible object is String
    • setDefaultClientProvider

      void setDefaultClientProvider(String defaultClientProvider) throws PropertyVetoException
      Sets the value of the defaultClientProvider property.
      Parameters:
      defaultClientProvider - allowed object is String
      Throws:
      PropertyVetoException
    • getProviderConfig

      List<ProviderConfig> getProviderConfig()
      Gets the value of the providerConfig property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the providerConfig property.

      For example, to add a new item, do as follows:

       getProviderConfig().add(newItem);
       

      Objects of the following type(s) are allowed in the list ProviderConfig