javax.servlet.sip.annotation.security

Annotation Type SipConstraint

@Documented
@Target(value={})
@Retention(value=RUNTIME)
public @interface SipConstraint

This annotation is used within the @SipSecurity annotation to represent the security constraints to be applied to all SIP protocol methods for which a corresponding @SipMethodConstraint element does NOT occur within the SipSecurity annotation. For the special case where an @SipConstraint that returns all default values occurs in combination with at least one @SipMethodConstraint that returns other than all default values, the @SipConstraint represents that no security constraint is to be applied to any of the SIP protocol methods to which a security constraint would otherwise apply. This exception is made to ensure that such potentially non-specific uses of @SipConstraint do not yield constraints that will explicitly establish unprotected access for such methods; given that they would not otherwise be covered by a constraint.

Since:

2.0

See Also:

SipSecurity

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	proxyAuthentication Value of this element dictates if the container must challenge the user agent with a 407 (Proxy Authentication Required) response status code when authenticating an incoming request.
String[]	rolesAllowed The names of the authorized roles.
SipSecurity.TransportGuarantee	transportGuarantee The data protection requirements (i.e., whether or not SSL/TLS is required) that must be satisfied by the connections on which requests arrive.
SipSecurity.EmptyRoleSemantic	value The default authorization semantic.

Element Detail

value

public abstract SipSecurity.EmptyRoleSemantic value

The default authorization semantic. This value is insignificant when rolesAllowed returns a non-empty array, and should not be specified when a non-empty array is specified for rolesAllowed.

Returns:

the SipSecurity.EmptyRoleSemantic to be applied when rolesAllowed returns an empty (that is, zero-length) array.

Default:

javax.servlet.sip.annotation.security.SipSecurity.EmptyRoleSemantic.PERMIT

rolesAllowed

public abstract String[] rolesAllowed

The names of the authorized roles. Duplicate role names appearing in rolesAllowed are insignificant and may be discarded during runtime processing of the annotation. The String "*" has no special meaning as a role name (should it occur in rolesAllowed).

Returns:

an array of zero or more role names. When the array contains zero elements, its meaning depends on the EmptyRoleSemantic returned by the value method. If value returns DENY, and rolesAllowed returns a zero length array, access is to be denied independent of authentication state and identity. Conversely, if value returns PERMIT, it indicates that access is to be allowed independent of authentication state and identity. When the array contains the names of one or more roles, it indicates that access is contingent on membership in at least one of the named roles (independent of the EmptyRoleSemantic returned by the value method).

Default:

{}

transportGuarantee

public abstract SipSecurity.TransportGuarantee transportGuarantee

The data protection requirements (i.e., whether or not SSL/TLS is required) that must be satisfied by the connections on which requests arrive.

Returns:

the SipSecurity.TransportGuarantee indicating the data protection that must be provided by the connection.

Default:

javax.servlet.sip.annotation.security.SipSecurity.TransportGuarantee.NONE

proxyAuthentication

public abstract boolean proxyAuthentication

Value of this element dictates if the container must challenge the user agent with a 407 (Proxy Authentication Required) response status code when authenticating an incoming request. By default, a 401 (Unauthorized) status code is used

Returns:

True if 407 status code must be used, false otherwise.

Default:

false