| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| CacheService |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2005-2011 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
| 5 | * you may not use this file except in compliance with the License. | |
| 6 | * You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.opensource.org/licenses/ecl2.php | |
| 9 | * | |
| 10 | * Unless required by applicable law or agreed to in writing, software | |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 13 | * See the License for the specific language governing permissions and | |
| 14 | * limitations under the License. | |
| 15 | */ | |
| 16 | package org.kuali.rice.core.api.cache; | |
| 17 | ||
| 18 | ||
| 19 | import org.kuali.rice.core.api.exception.RiceIllegalArgumentException; | |
| 20 | ||
| 21 | import javax.jws.WebMethod; | |
| 22 | import javax.jws.WebParam; | |
| 23 | ||
| 24 | import javax.jws.soap.SOAPBinding; | |
| 25 | import java.util.Collection; | |
| 26 | ||
| 27 | /** | |
| 28 | * A service that enables executes various tasks on rice's caching infrastructure. | |
| 29 | */ | |
| 30 | //Specifically leaving off the @WebService annotation because this should be set manually when the service is exported. | |
| 31 | @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED) | |
| 32 | public interface CacheService { | |
| 33 | ||
| 34 | /** | |
| 35 | * Flushes an object from the cache based on a cache target. | |
| 36 | * | |
| 37 | * @param cacheTargets the targets to flush. cannot be null or contain null items | |
| 38 | * @throws IllegalArgumentException if the cacheTargets is null contains a null item. | |
| 39 | */ | |
| 40 | @WebMethod(operationName="flush") | |
| 41 | void flush(@WebParam(name = "cacheTargets") Collection<CacheTarget> cacheTargets) throws RiceIllegalArgumentException; | |
| 42 | } |