1
0
mirror of synced 2026-08-04 17:27:13 +00:00

SEC-2702: Clean WebSocket Namespace documentation

This commit is contained in:
Rob Winch
2014-11-25 12:27:29 -06:00
parent 8ad16b01f5
commit 2cb2657f5b
4 changed files with 76 additions and 11 deletions
@@ -276,22 +276,22 @@ protect-pointcut.attlist &=
attribute access {xsd:token}
messages =
## Messages
## Allows securing a Message Broker. There are two modes. If no id is specified: ensures that any SimpAnnotationMethodMessageHandler has the AuthenticationPrincipalArgumentResolver registered as a custom argument resolver; ensures that the SecurityContextChannelInterceptor is automatically registered for the clientInboundChannel; and that a ChannelSecurityInterceptor is registered with the clientInboundChannel. If the id is specified, creates a ChannelSecurityInterceptor that can be manually registered with the clientInboundChannel.
element messages { messages.attrlist, (message-interceptor*) }
messages.attrlist &=
## the id
## A bean identifier, used for referring to the bean elsewhere in the context. If specified, explicit configuration within clientInboundChannel is required. If not specified, ensures that any SimpAnnotationMethodMessageHandler has the AuthenticationPrincipalArgumentResolver registered as a custom argument resolver; ensures that the SecurityContextChannelInterceptor is automatically registered for the clientInboundChannel; and that a ChannelSecurityInterceptor is registered with the clientInboundChannel.
attribute id {xsd:token}?
message-interceptor =
## Message
## Creates an authorization rule for a message.
element message-interceptor {message-interceptor.attrlist}
message-interceptor.attrlist &=
## pattern
## The destination ant pattern which will be mapped to the access attribute. For example, /** matches any message with a destination, /admin/** matches any message that has a destination that starts with admin.
attribute pattern {xsd:token}?
message-interceptor.attrlist &=
## access
## The access configuration attributes that apply for the configured message. For example, permitAll grants access to anyone, hasRole('ROLE_ADMIN') requires the user have the role 'ROLE_ADMIN'.
attribute access {xsd:token}?
http-firewall =
@@ -855,7 +855,13 @@
</xs:attributeGroup>
<xs:element name="messages">
<xs:annotation>
<xs:documentation>Messages
<xs:documentation>Allows securing a Message Broker. There are two modes. If no id is specified: ensures that
any SimpAnnotationMethodMessageHandler has the AuthenticationPrincipalArgumentResolver
registered as a custom argument resolver; ensures that the
SecurityContextChannelInterceptor is automatically registered for the
clientInboundChannel; and that a ChannelSecurityInterceptor is registered with the
clientInboundChannel. If the id is specified, creates a ChannelSecurityInterceptor that
can be manually registered with the clientInboundChannel.
</xs:documentation>
</xs:annotation>
<xs:complexType>
@@ -868,14 +874,20 @@
<xs:attributeGroup name="messages.attrlist">
<xs:attribute name="id" type="xs:token">
<xs:annotation>
<xs:documentation>the id
<xs:documentation>A bean identifier, used for referring to the bean elsewhere in the context. If specified,
explicit configuration within clientInboundChannel is required. If not specified, ensures
that any SimpAnnotationMethodMessageHandler has the
AuthenticationPrincipalArgumentResolver registered as a custom argument resolver; ensures
that the SecurityContextChannelInterceptor is automatically registered for the
clientInboundChannel; and that a ChannelSecurityInterceptor is registered with the
clientInboundChannel.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="message-interceptor">
<xs:annotation>
<xs:documentation>Message
<xs:documentation>Creates an authorization rule for a message.
</xs:documentation>
</xs:annotation>
<xs:complexType>
@@ -885,13 +897,17 @@
<xs:attributeGroup name="message-interceptor.attrlist">
<xs:attribute name="pattern" type="xs:token">
<xs:annotation>
<xs:documentation>pattern
<xs:documentation>The destination ant pattern which will be mapped to the access attribute. For example, /**
matches any message with a destination, /admin/** matches any message that has a
destination that starts with admin.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="access" type="xs:token">
<xs:annotation>
<xs:documentation>access
<xs:documentation>The access configuration attributes that apply for the configured message. For example,
permitAll grants access to anyone, hasRole('ROLE_ADMIN') requires the user have the role
'ROLE_ADMIN'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
@@ -29,7 +29,7 @@ import spock.lang.*
*/
class XsdDocumentedTests extends Specification {
def ignoredIds = ['nsa-any-user-service','nsa-any-user-service-parents','nsa-authentication','nsa-ldap','nsa-method-security','nsa-web']
def ignoredIds = ['nsa-any-user-service','nsa-any-user-service-parents','nsa-authentication','nsa-message-security','nsa-ldap','nsa-method-security','nsa-web']
@Shared def reference = new File('../docs/manual/src/asciidoc/index.adoc')
@Shared File schema31xDocument = new File('src/main/resources/org/springframework/security/config/spring-security-3.1.xsd')