1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.chemistry.opencmis.commons.spi; 20 21 import java.util.List; 22 23 import org.apache.chemistry.opencmis.commons.data.ExtensionsData; 24 import org.apache.chemistry.opencmis.commons.data.ObjectData; 25 26 /** 27 * Policy Service interface. 28 * 29 * <p> 30 * <em> 31 * See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, parameters, 32 * exceptions and the domain model. 33 * </em> 34 * </p> 35 */ 36 public interface PolicyService { 37 38 /** 39 * Applies a specified policy to an object. 40 * 41 * @param repositoryId 42 * the identifier for the repository 43 * @param policyId 44 * the policy to add 45 * @param objectId 46 * the object 47 * @param extension 48 * extension data 49 */ 50 void applyPolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension); 51 52 /** 53 * Removes a specified policy from an object. 54 * 55 * @param repositoryId 56 * the identifier for the repository 57 * @param policyId 58 * the policy to remove 59 * @param objectId 60 * the object 61 * @param extension 62 * extension data 63 */ 64 void removePolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension); 65 66 /** 67 * Gets the list of policies currently applied to the specified object. 68 * 69 * @param repositoryId 70 * the identifier for the repository 71 * @param objectId 72 * the object 73 * @param filter 74 * <em>(optional)</em> a comma-separated list of query names that 75 * defines which properties must be returned by the repository 76 * (default is repository specific) 77 * @param extension 78 * extension data 79 * 80 * @return the list of applied policies 81 */ 82 List<ObjectData> getAppliedPolicies(String repositoryId, String objectId, String filter, ExtensionsData extension); 83 }