org.mule.runtime.extension.api.connectivity.oauth

Class OAuthParameterModelProperty

java.lang.Object

org.mule.runtime.extension.api.connectivity.oauth.OAuthParameterModelProperty

All Implemented Interfaces:

Serializable, org.mule.runtime.api.meta.model.ModelProperty, org.mule.runtime.api.meta.NamedObject

public class OAuthParameterModelProperty
extends Object
implements org.mule.runtime.api.meta.model.ModelProperty

A private ModelProperty used on ParameterModel instances, indicating that such parameter should be used as an OAuth parameter.

This is equivalent to the OAuthParameter annotation

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuthParameterModelProperty(String requestAlias) Deprecated. since 1.2.1. Use OAuthParameterModelProperty(String, HttpParameterPlacement) instead
OAuthParameterModelProperty(String requestAlias, HttpParameterPlacement placement)

Method Summary

Modifier and Type	Method and Description
String	getName()
HttpParameterPlacement	getPlacement()
String	getRequestAlias()
boolean	isPublic()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthParameterModelProperty

@Deprecated
public OAuthParameterModelProperty(String requestAlias)

Deprecated. since 1.2.1. Use OAuthParameterModelProperty(String, HttpParameterPlacement) instead

Creates a new instance using HttpParameterPlacement.QUERY_PARAMS as the default placement.

Parameters:

requestAlias - the name under which the parameter is sent to the OAuth provider during the authentication dance

OAuthParameterModelProperty

public OAuthParameterModelProperty(String requestAlias,
                                   HttpParameterPlacement placement)

Method Detail

getRequestAlias

public String getRequestAlias()

Returns:

the name under which the parameter is sent to the OAuth provider during the authentication dance

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.model.ModelProperty

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

Returns:

oauthParameter

getPlacement

public HttpParameterPlacement getPlacement()

Returns:

The parameter's placement

Since:

1.2.1

isPublic

public boolean isPublic()

Specified by:

isPublic in interface org.mule.runtime.api.meta.model.ModelProperty

Returns:

false