com.google.api.tools.framework.aspects.authentication

Class AuthConfigAspect

java.lang.Object

com.google.api.tools.framework.aspects.ConfigAspectBase

com.google.api.tools.framework.aspects.RuleBasedConfigAspect<com.google.api.AuthenticationRule,AuthAttribute>

com.google.api.tools.framework.aspects.authentication.AuthConfigAspect

All Implemented Interfaces:

ConfigAspect

public class AuthConfigAspect
extends RuleBasedConfigAspect<com.google.api.AuthenticationRule,AuthAttribute>

Configuration aspect for authentication binding.

Method Summary

Modifier and Type	Method and Description
protected void	addToRuleBuilder(com.google.api.Service.Builder serviceBuilder, java.lang.String selector, AuthAttribute binding) Adds a rule back to the rule builder, specialized for the given selector.
protected void	clearRuleBuilder(com.google.api.Service.Builder builder) Clears the rule builder during normalization.
static AuthConfigAspect	create(Model model)
protected AuthAttribute	evaluate(ProtoElement element, com.google.api.AuthenticationRule rule, boolean isFromIdl) Evaluates the rule w.r.t.
java.lang.String	getDocumentation(ProtoElement element) Default implementation of aspect documentation.
java.lang.String	getDocumentationTitle(ProtoElement element) Default implementation of aspect documentation title.
protected boolean	isApplicable(ProtoElement element) Predicate determining whether a rule of the aspect is applicable to the element.
java.util.List<java.lang.Class<? extends ConfigAspect>>	mergeDependencies() Returns an empty list since this aspect does not depend on any other aspects.

Methods inherited from class com.google.api.tools.framework.aspects.RuleBasedConfigAspect

endMerging, fromIdlLayer, merge, normalize, startNormalization

Methods inherited from class com.google.api.tools.framework.aspects.ConfigAspectBase

asDiagCollector, endLinting, endNormalization, error, getAspectName, getLintRuleNames, getLocationInConfig, getLocationOfRepeatedFieldInConfig, getModel, lint, lintWarning, registerLintRule, registerLintRuleName, startLinting, startMerging, warning

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AuthConfigAspect create(Model model)

mergeDependencies

public java.util.List<java.lang.Class<? extends ConfigAspect>> mergeDependencies()

Returns an empty list since this aspect does not depend on any other aspects.

isApplicable

protected boolean isApplicable(ProtoElement element)

Description copied from class: RuleBasedConfigAspect

Predicate determining whether a rule of the aspect is applicable to the element.

Specified by:

isApplicable in class RuleBasedConfigAspect<com.google.api.AuthenticationRule,AuthAttribute>

evaluate

protected AuthAttribute evaluate(ProtoElement element,
                                 com.google.api.AuthenticationRule rule,
                                 boolean isFromIdl)

Description copied from class: RuleBasedConfigAspect

Evaluates the rule w.r.t. the given element and returns the attribute which should be attached to the element. May add errors on the element's model, and may return null if evaluation fails.

Specified by:

evaluate in class RuleBasedConfigAspect<com.google.api.AuthenticationRule,AuthAttribute>

clearRuleBuilder

protected void clearRuleBuilder(com.google.api.Service.Builder builder)

Description copied from class: RuleBasedConfigAspect

Clears the rule builder during normalization.

Specified by:

clearRuleBuilder in class RuleBasedConfigAspect<com.google.api.AuthenticationRule,AuthAttribute>

addToRuleBuilder

protected void addToRuleBuilder(com.google.api.Service.Builder serviceBuilder,
                                java.lang.String selector,
                                AuthAttribute binding)

Description copied from class: RuleBasedConfigAspect

Adds a rule back to the rule builder, specialized for the given selector.

Specified by:

addToRuleBuilder in class RuleBasedConfigAspect<com.google.api.AuthenticationRule,AuthAttribute>

getDocumentationTitle

public java.lang.String getDocumentationTitle(ProtoElement element)

Description copied from class: ConfigAspectBase

Default implementation of aspect documentation title. Returns null, indicating the aspect is not documented.

Specified by:

getDocumentationTitle in interface ConfigAspect

Overrides:

getDocumentationTitle in class ConfigAspectBase

getDocumentation

public java.lang.String getDocumentation(ProtoElement element)

Description copied from class: ConfigAspectBase

Default implementation of aspect documentation. Returns null, indicating the aspect is not documented.

Specified by:

getDocumentation in interface ConfigAspect

Overrides:

getDocumentation in class ConfigAspectBase