001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors.
008     *
009     * Unless otherwise indicated, all code in JBoss DNA is licensed
010     * to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     * 
014     * JBoss DNA 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     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.graph.request;
025    
026    import java.util.Set;
027    
028    /**
029     * A request to obtain the information about the workspaces that are available.
030     */
031    public class GetWorkspacesRequest extends CacheableRequest {
032    
033        private static final long serialVersionUID = 1L;
034    
035        private Set<String> availableWorkspaceNames;
036    
037        /**
038         * Create a request to obtain the information about the available workspaces.
039         */
040        public GetWorkspacesRequest() {
041        }
042    
043        /**
044         * {@inheritDoc}
045         * 
046         * @see org.jboss.dna.graph.request.Request#isReadOnly()
047         */
048        @Override
049        public boolean isReadOnly() {
050            return true;
051        }
052    
053        /**
054         * Get the names of workspaces that are available (at least to the current user)
055         * 
056         * @return the set of workspace names, or null if the request has not been completed
057         */
058        public Set<String> getAvailableWorkspaceNames() {
059            return availableWorkspaceNames;
060        }
061    
062        /**
063         * Set the names of the workspaces that are available (at least to the current user)
064         * 
065         * @param availableWorkspaceNames Sets availableWorkspaceNames to the specified value.
066         */
067        public void setAvailableWorkspaceNames( Set<String> availableWorkspaceNames ) {
068            this.availableWorkspaceNames = availableWorkspaceNames;
069        }
070    
071        /**
072         * {@inheritDoc}
073         * 
074         * @see java.lang.Object#hashCode()
075         */
076        @Override
077        public int hashCode() {
078            return getClass().hashCode();
079        }
080    
081        /**
082         * {@inheritDoc}
083         * 
084         * @see java.lang.Object#equals(java.lang.Object)
085         */
086        @Override
087        public boolean equals( Object obj ) {
088            if (obj == this) return true;
089            if (this.getClass().isInstance(obj)) {
090                // All workspace requests are consider equal
091                return true;
092            }
093            return false;
094        }
095    
096        /**
097         * {@inheritDoc}
098         * 
099         * @see java.lang.Object#toString()
100         */
101        @Override
102        public String toString() {
103            return "request workspaces";
104        }
105    
106    }