|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.p13n.advisor.AbstractAdvislet
public abstract class AbstractAdvislet
An abstract class which provides some default method implementations for classes wishing to implement the Advislet interface.
Field Summary | |
---|---|
protected Metadata |
advisletMetadata
The metadata for the Advislet |
protected Advisor |
advisor
The Advisor associated with this Advislet instance. |
protected Map |
parametersMap
The parameters Map for the Advislet |
Fields inherited from interface com.bea.p13n.advisor.AdviceConstants |
---|
RESULTS |
Constructor Summary | |
---|---|
AbstractAdvislet(Advisor advisor,
Metadata advisletMetadata)
Constructs a new AbstractAdvislet associated with the Advisor supplied. |
Method Summary | |
---|---|
Advice |
getAdvice(AdviceRequest request)
Makes recommendations based on the AdviceRequest passed in. |
protected Advisor |
getAdvisor()
Gets the Advisor associated with this Advislet. |
Metadata |
getMetadata()
Returns the metadata for the Advislet. |
Object[] |
getRequiredAttributes()
Returns an array of required attributes for the advislet. |
boolean |
initialize(Map parameters,
Object parameterDocument)
Initializes this with the given parameters and a parameterDocument . |
String |
toString()
Returns a String representation of this. |
void |
validateAdviceRequest(AdviceRequest request)
Allows for custom AdviceRequest validation logic in addition to the required attribute checking performed by the Advisor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected Advisor advisor
protected Metadata advisletMetadata
protected Map parametersMap
Constructor Detail |
---|
public AbstractAdvislet(Advisor advisor, Metadata advisletMetadata)
Method Detail |
---|
public boolean initialize(Map parameters, Object parameterDocument) throws AdvisorException
parameters
and a parameterDocument
.
initialize
in interface AdvisletChainElement
parameters
- A map containing key-value pairs.parameterDocument
- An Object
representing a parameter document.
true
if this operation is successful, otherwise returns
false
.
AdvisorException
- If an error occurs during initialization process.protected Advisor getAdvisor()
public Metadata getMetadata()
getMetadata
in interface AdvisletChainElement
public Advice getAdvice(AdviceRequest request) throws IllegalArgumentException, AdvisorException
Advislet
getAdvice
in interface Advislet
request
- The advice request for which to make a recommendation.
IllegalArgumentException
- thrown if the adviceRequest parameter
is null or if it is an unsupported type.
AdvisorException
- thrown on an error when processing the request.public void validateAdviceRequest(AdviceRequest request) throws IllegalArgumentException
Advislet
validateAdviceRequest
in interface Advislet
request
- the request to validate.
IllegalArgumentException
- thrown if the adviceRequest parameter
is null or if it is an unsupported type.public Object[] getRequiredAttributes()
Advislet
validateAdviceRequest
method to perform additional processing
above and beyond attribute type checking.
getRequiredAttributes
in interface Advislet
public String toString()
toString
in class Object
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |