org.mule.api.annotations.components

Annotation Type HttpBasicAuth

@Target(value=TYPE)
@Retention(value=SOURCE)
@Documented
public @interface HttpBasicAuth

This annotation is used to define HTTP Authentication RFC2617 strategy (see http://tools.ietf.org/html/rfc2617), where it assumes that the custom component contains fields annotated with BasicAuthUsername and BasicAuthPassword.

Using the default values for headerName() and prefix(), if the user agent wishes to send the userid "Aladdin" and password "open sesame", it would use the following header field:

• Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	friendlyName Provides a friendly name for the strategy.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	configElementName Name of the configuration element
String	headerName Name of the header that will contain the username and password encoded in Base64
String	prefix Prefix that will be used be used before the username and password encoded into base64.

Element Detail

friendlyName

public abstract String friendlyName

Provides a friendly name for the strategy.

configElementName

public abstract String configElementName

Name of the configuration element

Default:

"config"

headerName

public abstract String headerName

Name of the header that will contain the username and password encoded in Base64

Default:

"Authorization"

prefix

public abstract String prefix

Prefix that will be used be used before the username and password encoded into base64.

Default:

"Basic "