javax.servlet.sip.annotation.security

Annotation Type SipMethodConstraint

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

This annotation is used within the SipSecurity annotation to represent security constraints on specific SIP protocol messages.

Since:

2.0

See Also:

SipSecurity

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value SIP protocol method name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
SipSecurity.EmptyRoleSemantic	emptyRoleSemantic The default authorization semantic.
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.

Element Detail

value

public abstract String value

SIP protocol method name. The method name must be a legitimate SIP Method name as defined by RFC 3261.

Returns:

the name of an SIP protocol method. value may not be null, or the empty string.

emptyRoleSemantic

public abstract SipSecurity.EmptyRoleSemantic emptyRoleSemantic

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

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

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 value returned by emptyRoleSemantic. If emptyRoleSemantic returns DENY, and rolesAllowed returns a zero length array, access is to be denied independent of authentication state and identity. Conversely, if emptyRoleSemantic 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 value returned by emptyRoleSemantic).

Default:

{}