/** * Authenticate as the guest user. This may not be allowed and throw an exception. * * @throws AuthenticationException */ @Auditable public void authenticateAsGuest() throws AuthenticationException;
/** * Check if Guest user authentication is allowed. * * @return true if Guest user authentication is allowed, false otherwise */ @Auditable public boolean guestUserAuthenticationAllowed();
/** * Invalidate a single ticket by ID * * @param ticket String * @throws AuthenticationException */ @Auditable(parameters = {"ticket"}, recordable = {false}) public void invalidateTicket(String ticket) throws AuthenticationException;
/** * Does this instance allow users to update their passwords? */ @Auditable public Set<String> getDomiansThatAllowUserPasswordChanges();
/** * Get the copies of a given node * * @param originalNodeRef the original node reference * @param pagingRequest page request details * @return the page(s) of nodes that were copied from the given node */ @Auditable(parameters = {"originalNodeRef"}) public PagingResults<CopyInfo> getCopies(NodeRef originalNodeRef, PagingRequest pagingRequest);
/** * Indicates whether rules are currently enabled for the current thread or not * * @see #enableRules * @see #disableRules * * @return true if rules are enabled for the current thread, false otherwise */ @Auditable public boolean isEnabled();
/** * Get all the rules associated with an actionable node, including those * inherited from parents. * <p> * An exception is raised if the actionable aspect is not present on the * passed node. * * @param nodeRef the node reference * @return a list of the rules associated with the node */ @Auditable(parameters = {"nodeRef"}) public List<Rule> getRules(NodeRef nodeRef);
/** * Get the rule given its node reference * * @param nodeRef the node reference * @return the rule corresponding to the node reference */ @Auditable(parameters = {"nodeRef"}) public Rule getRule(NodeRef nodeRef);
/** * Saves the details of the rule to the specified node reference. * <p> * If the rule is already associated with the node, the details are updated * with those specified. * * @param nodeRef NodeRef * @param rule Rule */ @Auditable(parameters = {"nodeRef", "rule"}) public void saveRule(NodeRef nodeRef, Rule rule);
/** * Returns the owning node reference for a rule. * * @param rule the rule * @return the owning node reference */ @Auditable(parameters = {"rule"}) public NodeRef getOwningNodeRef(Rule rule);
/** * Returns the owning node reference for an action. Returns null for an unsaved action or one that is not * parented by a rule. * * NOTE: this method is temporary and will be removed in future versions. It should only be used with good reason. * * @param action the action * @return the owning node reference */ @Auditable(parameters = {"action"}) public NodeRef getOwningNodeRef(Action action);
/** * Get a list of the all the rule nodes that link to the passed rule node. * Returns an empty list if none link. * * @param nodeRef node reference of a rule node * @return list of rule nodes that link to this passed rule node, empty if none */ @Auditable(parameters = {"nodeRef"}) public List<NodeRef> getLinkedFromRuleNodes(NodeRef nodeRef); }
/** * Gets all (including previous) Workflow Definitions for the given unique name * * @param workflowName workflow name e.g. activiti$activitiReview * @return the deployed workflow definition (or null if not found) */ @Auditable(parameters = {"workflowName"}) public List<WorkflowDefinition> getAllDefinitionsByName(String workflowName);
/** * Gets a graphical view of the Workflow Definition * * @param workflowDefinitionId the workflow definition id * @return graphical image of workflow definition */ @Auditable(parameters = {"workflowDefinitionId"}) public byte[] getDefinitionImage(String workflowDefinitionId);
/** * Gets a writer to a temporary location. The longevity of the stored * temporary content is determined by the system. * * @return Returns a writer onto a temporary location */ @Auditable public ContentWriter getTempWriter();
/** * @deprecated use {@link #getTransformers(String, String, long, String, TransformationOptions)}. * @since 3.5 */ @Auditable(parameters = {"sourceMimetype", "sourceSize", "targetMimetype", "options"}) public List<ContentTransformer> getActiveTransformers(String sourceMimetype, long sourceSize, String targetMimetype, TransformationOptions options);
/** * Get a list of all the categories appropriate for a given property. * The full list of categories that may be assigned for this aspect. * * @param storeRef StoreRef * @param aspectQName QName * @param depth - the enumeration depth for what level to recover * @return a collection of all the nodes found identified by their ChildAssocRef's */ @Auditable(parameters = {"storeRef", "aspectQName", "depth"}) public Collection<ChildAssociationRef> getCategories(StoreRef storeRef, QName aspectQName, Depth depth );
/** * Get all the classification entries * */ @Auditable(parameters = {"storeRef"}) public Collection<ChildAssociationRef> getClassifications(StoreRef storeRef);
/** * Create a new category. * * This will extend the category types in the data dictionary * All it needs is the type name and the attribute in which to store noderefs to categories. * * @param storeRef StoreRef * @param aspectName QName * @param attributeName String */ @Auditable(parameters = {"storeRef", "aspectName", "attributeName"}) public NodeRef createClassification(StoreRef storeRef, QName aspectName, String attributeName);
/** * Get the most polular categories * * @param storeRef StoreRef * @param aspectName QName * @param count int * @return List */ @Auditable(parameters = {"storeRef", "aspectName", "count"}) public List<Pair<NodeRef, Integer>> getTopCategories(StoreRef storeRef, QName aspectName, int count); }