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

Class OAuthModelProperty

java.lang.Object

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

All Implemented Interfaces:

Serializable, ModelProperty, NamedObject

public class OAuthModelProperty
extends Object
implements ModelProperty

A public ModelProperty used to indicate that a ConnectionProvider supports a number of OAuth2 grant types

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
OAuthModelProperty(List<OAuthGrantType> grantTypes) Creates a new instance

Method Summary

Modifier and Type	Method and Description
List<OAuthGrantType>	getGrantTypes()
String	getName() A unique name which identifies this property.
boolean	isPublic() Whether this instance should be included when serializing or sharing the owning EnrichableModel or if on the contrary, this model property holds information which is proprietary to the runtime and should not communicated.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

OAuthModelProperty

public OAuthModelProperty(List<OAuthGrantType> grantTypes)

Creates a new instance

Parameters:

grantTypes - the grant types supported

Method Detail

getName

public String getName()

A unique name which identifies this property. No model should contain two instances with the same name

Specified by:

getName in interface ModelProperty

Specified by:

getName in interface NamedObject

Returns:

oauth

isPublic

public boolean isPublic()

Whether this instance should be included when serializing or sharing the owning EnrichableModel or if on the contrary, this model property holds information which is proprietary to the runtime and should not communicated.

Non public properties should be skipped by serializers and any other kind of sharing mechanisms.

BEWARE: Non public model properties are not to be considered API and thus nobody (or anything) should depend on it. Backwards compatibility will not be guaranteed on non public properties.

Specified by:

isPublic in interface ModelProperty

Returns:

true

getGrantTypes

public List<OAuthGrantType> getGrantTypes()

Returns:

the supported grant types