Examples with Policy org.apache.chemistry.opencmis.client.api.Policy used on opensource projects

Example 1 with Policy

use of org.apache.chemistry.opencmis.client.api.Policy in project copper-cms by PogeyanOSS.

the class AbstractSessionTest method createPolicy.

/**
 * Creates a policy.
 */
protected Policy createPolicy(Session session, Folder parent, String name, String policyText, String objectTypeId) {
    if (parent == null) {
        throw new IllegalArgumentException("Parent is not set!");
    }
    if (name == null) {
        throw new IllegalArgumentException("Name is not set!");
    }
    if (objectTypeId == null) {
        throw new IllegalArgumentException("Object Type ID is not set!");
    }
    // check type
    ObjectType type;
    try {
        type = session.getTypeDefinition(objectTypeId);
    } catch (CmisObjectNotFoundException e) {
        addResult(createResult(UNEXPECTED_EXCEPTION, "Policy type '" + objectTypeId + "' is not available: " + e.getMessage(), e, true));
        return null;
    }
    if (Boolean.FALSE.equals(type.isCreatable())) {
        addResult(createResult(SKIPPED, "Policy type '" + objectTypeId + "' is not creatable!", true));
        return null;
    }
    boolean isFilable = Boolean.TRUE.equals(type.isFileable());
    addResult(createResult(INFO, "Policy type '" + objectTypeId + "' is " + (isFilable ? "" : "not ") + "filable."));
    // create
    Map<String, Object> properties = new HashMap<String, Object>();
    properties.put(PropertyIds.NAME, name);
    properties.put(PropertyIds.OBJECT_TYPE_ID, objectTypeId);
    if (policyText != null) {
        properties.put(PropertyIds.POLICY_TEXT, policyText);
    }
    Policy result = null;
    try {
        // create the item
        if (isFilable) {
            result = parent.createPolicy(properties, null, null, null, SELECT_ALL_NO_CACHE_OC);
        } else {
            ObjectId policyId = session.createPolicy(properties, null, null, null, null);
            result = (Policy) session.getObject(policyId, SELECT_ALL_NO_CACHE_OC);
        }
    } catch (CmisBaseException e) {
        addResult(createResult(UNEXPECTED_EXCEPTION, "Policy could not be created! Exception: " + e.getMessage(), e, true));
        return null;
    }
    CmisTestResult f;
    try {
        // check item name
        f = createResult(FAILURE, "Policy name does not match!", false);
        addResult(assertEquals(name, result.getName(), null, f));
        addResult(checkObject(session, result, getAllProperties(result), "New policy object spec compliance"));
    } catch (CmisBaseException e) {
        addResult(createResult(UNEXPECTED_EXCEPTION, "Newly created policy is invalid! Exception: " + e.getMessage(), e, true));
    }
    // check parents
    List<Folder> parents = result.getParents(SELECT_ALL_NO_CACHE_OC);
    if (isFilable) {
        boolean found = false;
        for (Folder folder : parents) {
            if (parent.getId().equals(folder.getId())) {
                found = true;
                break;
            }
        }
        if (!found) {
            addResult(createResult(FAILURE, "The folder the item has been created in is not in the list of the item parents!"));
        }
    } else {
        f = createResult(FAILURE, "Policy is not filable but has a parent!", false);
        addResult(assertIsTrue(parents.isEmpty(), null, f));
    }
    return result;
}

Example 2 with Policy

use of org.apache.chemistry.opencmis.client.api.Policy in project copper-cms by PogeyanOSS.

the class AbstractSessionTest method checkObject.

protected CmisTestResult checkObject(Session session, CmisObject object, String[] properties, String message) {
    List<CmisTestResult> results = new ArrayList<CmisTestResult>();
    CmisTestResult f;
    f = createResult(FAILURE, "Object is null!", true);
    addResult(results, assertNotNull(object, null, f));
    if (object != null) {
        f = createResult(FAILURE, "Object ID is not set!");
        addResult(results, assertStringNotEmpty(object.getId(), null, f));
        GregorianCalendar creationDate = null;
        GregorianCalendar lastModificationDate = null;
        // properties
        for (String propId : properties) {
            Property<?> prop = object.getProperty(propId);
            // values of non-spec properties are not checked here
            PropertyCheckEnum propertyCheck = PropertyCheckEnum.NO_VALUE_CHECK;
            // known properties that are strings and must be set
            if (PropertyIds.OBJECT_ID.equals(propId) || PropertyIds.BASE_TYPE_ID.equals(propId) || PropertyIds.OBJECT_TYPE_ID.equals(propId) || PropertyIds.PATH.equals(propId) || PropertyIds.SOURCE_ID.equals(propId) || PropertyIds.TARGET_ID.equals(propId)) {
                propertyCheck = PropertyCheckEnum.STRING_MUST_NOT_BE_EMPTY;
            }
            if (!(object instanceof Relationship)) {
                if (PropertyIds.CREATED_BY.equals(propId) || PropertyIds.LAST_MODIFIED_BY.equals(propId)) {
                    propertyCheck = PropertyCheckEnum.STRING_MUST_NOT_BE_EMPTY;
                }
            }
            // known properties that are strings and should be set
            if (PropertyIds.NAME.equals(propId) || PropertyIds.POLICY_TEXT.equals(propId)) {
                propertyCheck = PropertyCheckEnum.STRING_SHOULD_NOT_BE_EMPTY;
            }
            // known properties that are not strings and must be set
            if (PropertyIds.IS_IMMUTABLE.equals(propId)) {
                propertyCheck = PropertyCheckEnum.MUST_BE_SET;
            }
            if (!(object instanceof Relationship)) {
                if (PropertyIds.CREATION_DATE.equals(propId) || PropertyIds.LAST_MODIFICATION_DATE.equals(propId)) {
                    propertyCheck = PropertyCheckEnum.MUST_BE_SET;
                }
            }
            // special case: parent
            if (PropertyIds.PARENT_ID.equals(propId)) {
                if (object instanceof Folder) {
                    if (((Folder) object).isRootFolder()) {
                        propertyCheck = PropertyCheckEnum.MUST_NOT_BE_SET;
                    } else {
                        propertyCheck = PropertyCheckEnum.STRING_MUST_NOT_BE_EMPTY;
                    }
                } else {
                    addResult(results, createResult(FAILURE, "Property " + PropertyIds.PARENT_ID + " is only defined for folders!"));
                }
            }
            // special case: path
            if (PropertyIds.PATH.equals(propId) && prop.getFirstValue() != null) {
                Object path = prop.getFirstValue();
                if (path instanceof String) {
                    f = createResult(FAILURE, "Path does not start with '/': " + path);
                    addResult(results, assertIsTrue(((String) path).length() > 0 && ((String) path).charAt(0) == '/', null, f));
                } else {
                    addResult(results, createResult(FAILURE, "Property " + PropertyIds.PATH + " is not a string!"));
                }
            }
            // check property
            addResult(results, checkProperty(prop, "Property " + propId, propertyCheck));
            // catch creationDate and lastModificationDate
            if (PropertyIds.CREATION_DATE.equals(propId)) {
                if (prop != null) {
                    creationDate = (GregorianCalendar) prop.getFirstValue();
                }
            } else if (PropertyIds.LAST_MODIFICATION_DATE.equals(propId)) {
                if (prop != null) {
                    lastModificationDate = (GregorianCalendar) prop.getFirstValue();
                }
            }
        }
        // check creationDate <= lastModificationDate
        if (creationDate != null && lastModificationDate != null) {
            f = createResult(FAILURE, "Last modification date precedes creation date!");
            addResult(results, assertIsTrue(creationDate.getTimeInMillis() <= lastModificationDate.getTimeInMillis(), null, f));
            f = createResult(WARNING, "Creation date and last modification date have different timezones.");
            addResult(assertIsTrue(creationDate.getTimeZone().hasSameRules(lastModificationDate.getTimeZone()), null, f));
        }
        // allowable actions
        if ((object.getAllowableActions() == null) || (object.getAllowableActions().getAllowableActions() == null)) {
            addResult(results, createResult(FAILURE, "Object has no allowable actions!"));
        } else {
            Set<Action> actions = object.getAllowableActions().getAllowableActions();
            f = createResult(FAILURE, "Object has no CAN_GET_PROPERTIES allowable action!");
            addResult(results, assertAllowableAction(object, Action.CAN_GET_PROPERTIES, null, f));
            addResult(results, assertIsTrue(object.hasAllowableAction(Action.CAN_GET_PROPERTIES), null, f));
            if (object instanceof Document) {
                if (actions.contains(Action.CAN_CHECK_OUT) && actions.contains(Action.CAN_CHECK_IN)) {
                    addResult(results, createResult(FAILURE, "Document object has CAN_CHECK_OUT and CAN_CHECK_IN allowable actions!"));
                }
                if (actions.contains(Action.CAN_CHECK_OUT) && actions.contains(Action.CAN_CANCEL_CHECK_OUT)) {
                    addResult(results, createResult(FAILURE, "Document object has CAN_CHECK_OUT and CAN_CANCEL_CHECK_OUT allowable actions!"));
                }
                Document doc = (Document) object;
                DocumentTypeDefinition docType = (DocumentTypeDefinition) doc.getType();
                if (doc.isVersionSeriesCheckedOut() != null) {
                    if (doc.isVersionSeriesCheckedOut()) {
                        f = createResult(WARNING, "Document is checked out and has CAN_CHECK_OUT allowable action!");
                        addResult(results, assertNotAllowableAction(object, Action.CAN_CHECK_OUT, null, f));
                        if (doc.getVersionSeriesCheckedOutId() == null) {
                            addResult(results, createResult(WARNING, "Document is checked out and but the property cmis:versionSeriesCheckedOutId is not set!"));
                        } else {
                            if (doc.getVersionSeriesCheckedOutId().equals(object.getId())) {
                                // object is PWC
                                f = createResult(FAILURE, "PWC doesn't have CAN_CHECK_IN allowable action!");
                                addResult(results, assertAllowableAction(object, Action.CAN_CHECK_IN, null, f));
                                f = createResult(FAILURE, "PWC doesn't have CAN_CANCEL_CHECK_OUT allowable action!");
                                addResult(results, assertAllowableAction(object, Action.CAN_CANCEL_CHECK_OUT, null, f));
                            } else {
                                // object is not PWC
                                f = createResult(WARNING, "Non-PWC has CAN_CHECK_IN allowable action!");
                                addResult(results, assertNotAllowableAction(object, Action.CAN_CHECK_IN, null, f));
                                f = createResult(WARNING, "Non-PWC has CAN_CANCEL_CHECK_OUT allowable action!");
                                addResult(results, assertNotAllowableAction(object, Action.CAN_CANCEL_CHECK_OUT, null, f));
                            }
                        }
                    } else {
                        f = createResult(FAILURE, "Document is not checked out and has CAN_CHECK_IN allowable action!");
                        addResult(results, assertNotAllowableAction(object, Action.CAN_CHECK_IN, null, f));
                        f = createResult(FAILURE, "Document is not checked out and has CAN_CANCEL_CHECK_OUT allowable action!");
                        addResult(results, assertNotAllowableAction(object, Action.CAN_CANCEL_CHECK_OUT, null, f));
                        // versionable check
                        if (docType.isVersionable()) {
                            // 
                            if (Boolean.TRUE.equals(doc.isLatestVersion())) {
                                f = createResult(WARNING, "Document is versionable and not checked but has no CAN_CHECK_OUT allowable action!");
                                addResult(results, assertAllowableAction(object, Action.CAN_CHECK_OUT, null, f));
                            }
                        } else {
                            f = createResult(FAILURE, "Document is not versionable but has CAN_CHECK_OUT allowable action!");
                            addResult(results, assertNotAllowableAction(object, Action.CAN_CHECK_OUT, null, f));
                        }
                    }
                } else {
                    addResult(results, createResult(WARNING, "Property cmis:isVersionSeriesCheckedOut is not set!"));
                }
                // immutable check
                if (Boolean.TRUE.equals(doc.isImmutable())) {
                    f = createResult(FAILURE, "Document is immutable and has CAN_UPDATE_PROPERTIES allowable action!");
                    addResult(results, assertNotAllowableAction(object, Action.CAN_UPDATE_PROPERTIES, null, f));
                    f = createResult(FAILURE, "Document is immutable and has CAN_DELETE_OBJECT allowable action!");
                    addResult(results, assertNotAllowableAction(object, Action.CAN_DELETE_OBJECT, null, f));
                }
            } else {
                f = createResult(FAILURE, "Non-Document object has CAN_CHECK_IN allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_CHECK_IN, null, f));
                f = createResult(FAILURE, "Non-Document object has CAN_CHECK_OUT allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_CHECK_OUT, null, f));
                f = createResult(FAILURE, "Non-Document object has CAN_CANCEL_CHECK_OUT allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_CANCEL_CHECK_OUT, null, f));
                f = createResult(FAILURE, "Non-Document object has CAN_GET_CONTENT_STREAM allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_GET_CONTENT_STREAM, null, f));
                f = createResult(FAILURE, "Non-Document object has CAN_DELETE_CONTENT_STREAM allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_DELETE_CONTENT_STREAM, null, f));
                f = createResult(FAILURE, "Non-Document object has CAN_GET_ALL_VERSIONS allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_GET_ALL_VERSIONS, null, f));
            }
            if (object instanceof Folder) {
                Folder folder = (Folder) object;
                if (folder.isRootFolder()) {
                    f = createResult(FAILURE, "Root folder has CAN_DELETE_OBJECT allowable action!");
                    addResult(results, assertNotAllowableAction(object, Action.CAN_DELETE_OBJECT, null, f));
                    f = createResult(FAILURE, "Root folder has CAN_GET_FOLDER_PARENT allowable action!");
                    addResult(results, assertNotAllowableAction(object, Action.CAN_GET_FOLDER_PARENT, null, f));
                    f = createResult(FAILURE, "Root folder has CAN_MOVE_OBJECT allowable action!");
                    addResult(results, assertNotAllowableAction(object, Action.CAN_MOVE_OBJECT, null, f));
                }
            } else {
                f = createResult(FAILURE, "Non-Folder object has CAN_GET_DESCENDANTS allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_GET_DESCENDANTS, null, f));
                f = createResult(FAILURE, "Non-Folder object has CAN_GET_FOLDER_PARENT allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_GET_FOLDER_PARENT, null, f));
                f = createResult(FAILURE, "Non-Folder object has CAN_GET_CHILDREN allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_GET_CHILDREN, null, f));
                f = createResult(FAILURE, "Non-Folder object has CAN_DELETE_TREE allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_DELETE_TREE, null, f));
                f = createResult(FAILURE, "Non-Folder object has CAN_GET_FOLDER_PARENT allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_GET_FOLDER_PARENT, null, f));
                f = createResult(FAILURE, "Non-Folder object has CAN_CREATE_DOCUMENT allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_CREATE_DOCUMENT, null, f));
                f = createResult(FAILURE, "Non-Folder object has CAN_CREATE_FOLDER allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_CREATE_FOLDER, null, f));
            }
            if (!(object instanceof FileableCmisObject) || (object instanceof Folder)) {
                f = createResult(FAILURE, "Non-Filable object or folder has CAN_ADD_OBJECT_TO_FOLDER allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_ADD_OBJECT_TO_FOLDER, null, f));
                f = createResult(FAILURE, "Non-Filable object or folder has CAN_REMOVE_OBJECT_FROM_FOLDER allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_REMOVE_OBJECT_FROM_FOLDER, null, f));
            }
            if (!(object instanceof FileableCmisObject)) {
                f = createResult(FAILURE, "Non-Fileable object has CAN_MOVE_OBJECT allowable action!");
                addResult(results, assertNotAllowableAction(object, Action.CAN_MOVE_OBJECT, null, f));
            }
            // get allowable actions again
            AllowableActions allowableActions = session.getBinding().getObjectService().getAllowableActions(session.getRepositoryInfo().getId(), object.getId(), null);
            if (allowableActions.getAllowableActions() == null) {
                addResult(results, createResult(FAILURE, "getAllowableActions() didn't returned allowable actions!"));
            } else {
                f = createResult(FAILURE, "Object allowable actions don't match the allowable actions returned by getAllowableActions()!");
                addResult(results, assertEqualSet(object.getAllowableActions().getAllowableActions(), allowableActions.getAllowableActions(), null, f));
            }
        }
        // check ACL
        if (object.getAcl() != null && object.getAcl().getAces() != null) {
            addResult(results, checkACL(session, object.getAcl(), true, "ACL"));
        }
        // check policies
        if (hasPolicies(session)) {
            try {
                List<ObjectData> appliedPolicies = session.getBinding().getPolicyService().getAppliedPolicies(session.getRepositoryInfo().getId(), object.getId(), "*", null);
                if (appliedPolicies == null) {
                    appliedPolicies = Collections.emptyList();
                }
                List<Policy> objectPolicies = object.getPolicies();
                if (objectPolicies == null) {
                    objectPolicies = Collections.emptyList();
                }
                f = createResult(FAILURE, "The number of policies returned by getAppliedPolicies() and the number of object policies don't match!");
                addResult(results, assertEquals(appliedPolicies.size(), objectPolicies.size(), null, f));
            } catch (CmisNotSupportedException e) {
                addResult(results, createResult(WARNING, "getAppliedPolicies() not supported for object: " + object.getId()));
            }
        }
        // check relationships
        checkRelationships(session, results, object);
        // check document content
        checkDocumentContent(session, results, object);
        // check renditions
        if (object.getRenditions() != null) {
            addResult(results, checkRenditions(session, object, "Rendition check"));
        }
        // check allowed child object type ids
        if (object instanceof Folder) {
            List<String> otids = object.getPropertyValue(PropertyIds.ALLOWED_CHILD_OBJECT_TYPE_IDS);
            if (otids != null) {
                for (String otid : otids) {
                    try {
                        session.getTypeDefinition(otid);
                    } catch (CmisBaseException e) {
                        addResult(results, createResult(FAILURE, "The cmis:allowedChildObjectTypeIds property contains the type ID '" + otid + "' but the type doesn't exists. Folder ID: " + object.getId()));
                    }
                }
            }
        }
        // check path
        if (object instanceof FileableCmisObject) {
            List<String> paths = ((FileableCmisObject) object).getPaths();
            if (object instanceof Folder) {
                f = createResult(FAILURE, "Folder does not have excatly one path! This is an OpenCMIS bug!");
                addResult(results, assertEquals(1, paths.size(), null, f));
            } else {
                if (Boolean.FALSE.equals(session.getRepositoryInfo().getCapabilities().isMultifilingSupported())) {
                    f = createResult(FAILURE, "Repository does not support multi-filing, but the object has more than one parent!");
                    addResult(results, assertIsTrue(paths.size() < 2, null, f));
                }
            }
        }
    }
    CmisTestResultImpl result = createResult(getWorst(results), message);
    result.getChildren().addAll(results);
    return result.getStatus().getLevel() <= OK.getLevel() ? null : result;
}

Example 3 with Policy

use of org.apache.chemistry.opencmis.client.api.Policy in project copper-cms by PogeyanOSS.

the class CreateAndDeletePolicyTest method run.

@Override
public void run(Session session) {
    if (hasPolicies(session)) {
        CmisTestResult f;
        // create a test folder
        Folder testFolder = createTestFolder(session);
        try {
            // create policy object
            Policy policy = createPolicy(session, testFolder, "testPolicy", "TCK Test Policy");
            // create document and apply policy
            Document doc = createDocument(session, testFolder, "testDocument", "Policy Test");
            if (Boolean.TRUE.equals(doc.getType().isControllablePolicy())) {
                doc.applyPolicy(policy);
                // check if policy has been applied
                List<Policy> policies1 = doc.getPolicies();
                boolean found1 = false;
                for (Policy p : policies1) {
                    if (p.getId().equals(policy.getId())) {
                        found1 = true;
                        break;
                    }
                }
                f = createResult(FAILURE, "Policy has not been applied to document! Policy Id: " + policy.getId() + ", Doc Id: " + doc.getId());
                addResult(assertIsTrue(found1, null, f));
                // get the policies
                List<ObjectData> policiesData2 = session.getBinding().getPolicyService().getAppliedPolicies(session.getRepositoryInfo().getId(), doc.getId(), "*", null);
                boolean found2 = false;
                if (policiesData2 != null && !policiesData2.isEmpty()) {
                    for (ObjectData p : policiesData2) {
                        if (p.getId().equals(policy.getId())) {
                            found2 = true;
                            break;
                        }
                    }
                }
                f = createResult(FAILURE, "Applied policy is not returned by the repository! Policy Id: " + policy.getId() + ", Doc Id: " + doc.getId());
                addResult(assertIsTrue(found2, null, f));
                // remove policy
                doc.removePolicy(policy);
                // check if policy has been applied
                List<Policy> policies3 = doc.getPolicies();
                if (policies3 != null) {
                    boolean found3 = false;
                    for (Policy p : policies3) {
                        if (p.getId().equals(policy.getId())) {
                            found3 = true;
                            break;
                        }
                    }
                    f = createResult(FAILURE, "Policy has not been removed from document! Policy Id: " + policy.getId() + ", Doc Id: " + doc.getId());
                    addResult(assertIsFalse(found3, null, f));
                }
            } else {
                addResult(createResult(INFO, "Document type " + doc.getType().getId() + " does not allow applying and removing policies. Choose a different document type for this test."));
            }
            // delete document
            deleteObject(doc);
            // delete policy object
            deleteObject(policy);
        } finally {
            // delete the test folder
            deleteTestFolder();
        }
    } else {
        addResult(createResult(SKIPPED, "Policies not supported. Test skipped!"));
    }
}