Class AbstractActionManager
java.lang.Object
org.apache.pdfbox.preflight.action.AbstractActionManager
- Direct Known Subclasses:
GoToAction
,HideAction
,InvalidAction
,NamedAction
,SubmitAction
,ThreadAction
,UndefAction
,UriAction
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Action name in a Additional Action dictionaryprotected COSDictionary
The action dictionary checked by this classprivate ActionManagerFactory
ActionManager factory used to create new ActionManagerprotected PreflightContext
The validation context -
Constructor Summary
ConstructorsConstructorDescriptionAbstractActionManager
(ActionManagerFactory amFact, COSDictionary adict, PreflightContext ctx, String aaKey) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract boolean
This method must be implemented by inherited classes to process specific validation.boolean
boolean
valid()
Call thevalid(boolean)
method with the additionalActionAuth set to false.boolean
valid
(boolean additionalActionAuth) Validate an Action dictionary.protected boolean
This method create a list of Action Managers which represent actions in the Next entry of the current action dictionary.
-
Field Details
-
actionFact
ActionManager factory used to create new ActionManager -
aaKey
Action name in a Additional Action dictionary -
actionDictionnary
The action dictionary checked by this class -
context
The validation context
-
-
Constructor Details
-
AbstractActionManager
AbstractActionManager(ActionManagerFactory amFact, COSDictionary adict, PreflightContext ctx, String aaKey) - Parameters:
amFact
- Instance of ActionManagerFactory used to create ActionManager to check Next actions.adict
- the COSDictionary of the action wrapped by this class.ctx
- the validation context .aaKey
- The name of the key which identify the action in a additional action dictionary.
-
-
Method Details
-
isAdditionalAction
public boolean isAdditionalAction()- Returns:
- the isAdditionalAction
-
getActionDictionnary
- Returns:
- the actionDictionary
-
getAdditionalActionKey
- Returns:
- the aaKey
-
validNextActions
This method create a list of Action Managers which represent actions in the Next entry of the current action dictionary. For each Next Action, the innerValid is called and the method returns false if a validation fails.- Returns:
- True if all Next Action are valid, false otherwise.
- Throws:
ValidationException
-
valid
Call thevalid(boolean)
method with the additionalActionAuth set to false.- Returns:
- the validation state.
- Throws:
ValidationException
-
valid
Validate an Action dictionary. Return false if the dictionary is invalid (ex : missing key). If the ActionManager represents an AdditionalAction, this method returns false and updates the error list when the additionalActionAuth parameter is set to false. This method call the innerValid method to process specific checks according to the action type. If innerValid successes, all actions contained in the Next entry of the Action dictionary are validated.- Parameters:
additionalActionAuth
- boolean to know if an additional action is authorized.- Returns:
- the validation state of the Action dictionary.
- Throws:
ValidationException
-
innerValid
This method must be implemented by inherited classes to process specific validation.- Returns:
- True if the action is valid, false otherwise.
- Throws:
ValidationException
-