001 //$HeadURL: svn+ssh://mschneider@svn.wald.intevation.org/deegree/base/trunk/resources/eclipse/svn_classfile_header_template.xml $
002 /*---------------- FILE HEADER ------------------------------------------
003 This file is part of deegree.
004 Copyright (C) 2001-2008 by:
005 Department of Geography, University of Bonn
006 http://www.giub.uni-bonn.de/deegree/
007 lat/lon GmbH
008 http://www.lat-lon.de
009
010 This library is free software; you can redistribute it and/or
011 modify it under the terms of the GNU Lesser General Public
012 License as published by the Free Software Foundation; either
013 version 2.1 of the License, or (at your option) any later version.
014 This library is distributed in the hope that it will be useful,
015 but WITHOUT ANY WARRANTY; without even the implied warranty of
016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017 Lesser General Public License for more details.
018 You should have received a copy of the GNU Lesser General Public
019 License along with this library; if not, write to the Free Software
020 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
021 Contact:
022
023 Andreas Poth
024 lat/lon GmbH
025 Aennchenstr. 19
026 53177 Bonn
027 Germany
028 E-Mail: poth@lat-lon.de
029
030 Prof. Dr. Klaus Greve
031 Department of Geography
032 University of Bonn
033 Meckenheimer Allee 166
034 53115 Bonn
035 Germany
036 E-Mail: greve@giub.uni-bonn.de
037 ---------------------------------------------------------------------------*/
038
039 package org.deegree.io.datastore;
040
041 import java.io.Serializable;
042 import java.util.Set;
043
044 import org.deegree.ogcwebservices.wfs.operation.GetFeatureWithLock;
045 import org.deegree.ogcwebservices.wfs.operation.LockFeature;
046
047 /**
048 * Represents a lock that has been acquired by a {@link LockFeature} or a {@link GetFeatureWithLock}
049 * request.
050 *
051 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
052 * @author last edited by: $Author:$
053 *
054 * @version $Revision:$, $Date:$
055 */
056 public class Lock implements Serializable {
057
058 private static final long serialVersionUID = 9140063407823707226L;
059
060 private String lockId;
061
062 private Set<String> lockedFids;
063
064 private long expiryTime;
065
066 /**
067 * Creates a new <code>Lock</code> from the given parameters.
068 *
069 * @param lockId
070 * id of the lock (must be unique)
071 * @param lockedFids
072 * locked feature ids
073 * @param expiryTime
074 * point in time when the <code>Lock</code> expires automatically
075 */
076 Lock( String lockId, Set<String> lockedFids, long expiryTime ) {
077 this.lockId = lockId;
078 this.lockedFids = lockedFids;
079 this.expiryTime = expiryTime;
080 }
081
082 /**
083 * Returns the unique lock identifier.
084 *
085 * @return the unique lock identifier
086 */
087 public String getId() {
088 return this.lockId;
089 }
090
091 /**
092 * Returns the ids of the features that are locked by this lock.
093 *
094 * @return the ids of the locked features
095 */
096 public Set<String> getLockedFids() {
097 return this.lockedFids;
098 }
099
100 /**
101 * Returns the point in time when this lock will automatically expire.
102 *
103 * @return the point in time when this lock will automatically expire
104 */
105 long getExpiryTime() {
106 return this.expiryTime;
107 }
108
109 @Override
110 public String toString() {
111 StringBuffer sb = new StringBuffer();
112 sb.append( "lock " + lockId + ": " );
113 int i = this.lockedFids.size();
114 for ( String fid : this.lockedFids ) {
115 sb.append( fid );
116 if ( --i != 0 ) {
117 sb.append( ", " );
118 }
119 }
120 return sb.toString();
121 }
122 }