javax.servlet.sip.annotation.security

Annotation Type SipLogin

@Inherited
@Documented
@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface SipLogin

This annotation is used within the @SipApplication annotation to represent the login configuration to be applied for the application.

Since:

2.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	authMethod Method of authentication used while authenticating SIP protocol messages.
SipLogin.IdentityAssertion	identityAssertion The identity assertion scheme to be used for identity assertion.
SipLogin.IdentityAssertionSupport	identityAssertionSupport This element is used to specify whether the identity assertion scheme specified using identityAssertion is REQUIRED or SUPPORTED by the application.
String	realmName Specifies the realm name to use for the authentication.

Element Detail

authMethod

public abstract String authMethod

Method of authentication used while authenticating SIP protocol messages. For example, for digest authentication, the value will be "DIGEST". By default, there is no method is enforced.

Returns:

A string indicating the authentication method.

Default:

"NONE"

realmName

public abstract String realmName

Specifies the realm name to use for the authentication.

Returns:

String representing the realm name.

Default:

""

identityAssertion

public abstract SipLogin.IdentityAssertion identityAssertion

The identity assertion scheme to be used for identity assertion.

Returns:

the IdentityAssertion scheme used for identity assertion.

Default:

javax.servlet.sip.annotation.security.SipLogin.IdentityAssertion.NONE

identityAssertionSupport

public abstract SipLogin.IdentityAssertionSupport identityAssertionSupport

This element is used to specify whether the identity assertion scheme specified using identityAssertion is REQUIRED or SUPPORTED by the application. If the identityAssertion is not specified, the value of this element will be ignored by the container.

Returns:

the IdentityAssertionSupport of the identityAssertion.

Default:

javax.servlet.sip.annotation.security.SipLogin.IdentityAssertionSupport.SUPPORTED