org.mule.connectivity.restconnect.internal.model.security

Class APISecurityScheme

java.lang.Object

org.mule.connectivity.restconnect.internal.model.security.APISecurityScheme

Direct Known Subclasses:

BasicAuthScheme, CustomAuthenticationScheme, DigestAuthenticationScheme, JwtAuthenticationScheme, OAuth2Scheme, PassThroughScheme, UnsecuredScheme

public abstract class APISecurityScheme
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASIC
protected List<Parameter>	configParameters
static String	CUSTOM_AUTHENTICATION
static String	CUSTOM_JWT
static String	DIGEST_AUTHENTICATION
protected List<Parameter>	headers
static String	JWT
static String	OAUTH1
static String	OAUTH2
static String	PASS_THROUGH
protected List<Parameter>	queryParameters
static String	UNSECURED

Constructor Summary

Constructors

Constructor and Description
APISecurityScheme()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	equalProperties(APISecurityScheme scheme)
boolean	equals(APISecurityScheme scheme)
boolean	equals(Object o)
List<Parameter>	getConfigParameters()
List<Parameter>	getHeaders()
List<Parameter>	getQueryParameters()
abstract String	getSchemeName()
static Parameter	getSecuritySchemeParameter(String name, String displayName, PrimitiveTypeSource.PrimitiveType type, String description, String defaultValue, String example, boolean required, boolean isPassword, boolean generated, String... enumValues)
static Parameter	getSecuritySchemeParameter(String name, String displayName, PrimitiveTypeSource.PrimitiveType type, String description, String defaultValue, String example, boolean required, boolean isPassword, String... enumValues)
boolean	hasConfigParameters()
int	hashCode()
boolean	hasHeaders()
boolean	hasQueryParameters()
abstract void	initializeConfigParameters()

Methods inherited from class java.lang.Object

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

Field Detail

BASIC

public static final String BASIC

See Also:

Constant Field Values

OAUTH1

public static final String OAUTH1

See Also:

Constant Field Values

OAUTH2

public static final String OAUTH2

See Also:

Constant Field Values

PASS_THROUGH

public static final String PASS_THROUGH

See Also:

Constant Field Values

DIGEST_AUTHENTICATION

public static final String DIGEST_AUTHENTICATION

See Also:

Constant Field Values

CUSTOM_AUTHENTICATION

public static final String CUSTOM_AUTHENTICATION

See Also:

Constant Field Values

JWT

public static final String JWT

See Also:

Constant Field Values

CUSTOM_JWT

public static final String CUSTOM_JWT

See Also:

Constant Field Values

UNSECURED

public static final String UNSECURED

See Also:

Constant Field Values

configParameters

protected List<Parameter> configParameters

headers

protected List<Parameter> headers

queryParameters

protected List<Parameter> queryParameters

Constructor Detail

APISecurityScheme

public APISecurityScheme()

Method Detail

getSchemeName

public abstract String getSchemeName()

initializeConfigParameters

public abstract void initializeConfigParameters()

getConfigParameters

public List<Parameter> getConfigParameters()

getQueryParameters

public List<Parameter> getQueryParameters()

getHeaders

public List<Parameter> getHeaders()

hasQueryParameters

public boolean hasQueryParameters()

hasHeaders

public boolean hasHeaders()

hasConfigParameters

public boolean hasConfigParameters()

equals

public boolean equals(APISecurityScheme scheme)

equalProperties

protected abstract boolean equalProperties(APISecurityScheme scheme)

getSecuritySchemeParameter

public static Parameter getSecuritySchemeParameter(String name,
                                                   String displayName,
                                                   PrimitiveTypeSource.PrimitiveType type,
                                                   String description,
                                                   String defaultValue,
                                                   String example,
                                                   boolean required,
                                                   boolean isPassword,
                                                   String... enumValues)

getSecuritySchemeParameter

public static Parameter getSecuritySchemeParameter(String name,
                                                   String displayName,
                                                   PrimitiveTypeSource.PrimitiveType type,
                                                   String description,
                                                   String defaultValue,
                                                   String example,
                                                   boolean required,
                                                   boolean isPassword,
                                                   boolean generated,
                                                   String... enumValues)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object