001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/repository/interfaces/CachedServiceReplyAccessor.java,v 1.1.1.1 2004/03/25 12:08:36 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:36 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruna
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruna nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040:
041: package es.udc.mypersonalizer.kernel.model.repository.interfaces;
042:
043: import java.util.Map;
044: import java.util.Collection;
045:
046: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
047:
048: /**
049: * This interface specifies the methods required to store and retrieve
050: * instances of the <code>CachedServiceReply</code> class.
051: *
052: * @author Fernando Bellas
053: * @since 1.0
054: */
055: public interface CachedServiceReplyAccessor {
056:
057: /**
058: * Finds a cached service reply.
059: *
060: * @param key the service property key
061: * @return the cached service reply or <code>null</code> if the reply was
062: * not cached
063: * @throws InternalErrorException if a severe failure occured
064: */
065: CachedServiceReply findCachedServiceReply(ServicePropertyKey key)
066: throws InternalErrorException;
067:
068: /**
069: * Finds some cached service replies. The <code>Map</code> will not
070: * contain any results for the cached replies that were not found.
071: *
072: * @param keys a collection of <code>ServicePropertyKey</code>s
073: * @return a <code>Map</code> of pairs like (<code>ServicePropertyKey,
074: * CachedServiceReply</code>)
075: * @throws InternalErrorException if a severe failure occured
076: */
077: Map findCachedServiceReplies(Collection keys)
078: throws InternalErrorException;
079:
080: /**
081: * Removes a cached service reply.
082: *
083: * @param key the service property key
084: * @throws InternalErrorException if a severe failure occured
085: */
086: void removeCachedServiceReply(ServicePropertyKey key)
087: throws InternalErrorException;
088:
089: /**
090: * Updates a cached service reply. This method does not throw any exception
091: * if it was unable to find the cached service reply to be updated.
092: *
093: * @param cachedServiceReply the new cached service reply
094: * @throws InternalErrorException if a severe failure occured
095: */
096: void updateCachedServiceReply(CachedServiceReply cachedServiceReply)
097: throws InternalErrorException;
098:
099: /**
100: * Removes the cached service replies that have been kept in
101: * the cache for more than the time period.
102: *
103: * @param timePeriod the time period in seconds
104: * @return the number of service replies that were removed
105: * @throws InternalErrorException if a severe failure occured
106: */
107: int removeOldCachedServiceReplies(int timePeriod)
108: throws InternalErrorException;
109:
110: /**
111: * Removes some cached service replies by service identifier.
112: *
113: * @param serviceIdentifier the service identifier
114: * @return the number of service replies that were removed
115: * @throws InternalErrorException if a severe failure occured
116: */
117: int removeOldCachedServiceReplies(String serviceIdentifier)
118: throws InternalErrorException;
119:
120: }
|