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     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed 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.connector.jbosscache;
025    
026    import java.util.concurrent.TimeUnit;
027    import javax.transaction.xa.XAResource;
028    import org.jboss.dna.graph.ExecutionContext;
029    import org.jboss.dna.graph.cache.CachePolicy;
030    import org.jboss.dna.graph.connector.RepositoryConnection;
031    import org.jboss.dna.graph.connector.RepositorySourceException;
032    import org.jboss.dna.graph.connector.RepositorySourceListener;
033    import org.jboss.dna.graph.request.Request;
034    import org.jboss.dna.graph.request.processor.RequestProcessor;
035    
036    /**
037     * The repository connection to a JBoss Cache instance.
038     * 
039     * @author Randall Hauch
040     */
041    public class JBossCacheConnection implements RepositoryConnection {
042    
043        protected static final RepositorySourceListener NO_OP_LISTENER = new RepositorySourceListener() {
044    
045            /**
046             * {@inheritDoc}
047             */
048            public void notify( String sourceName,
049                                Object... events ) {
050                // do nothing
051            }
052        };
053    
054        private final JBossCacheSource source;
055        private final JBossCacheWorkspaces workspaces;
056        private RepositorySourceListener listener = NO_OP_LISTENER;
057    
058        JBossCacheConnection( JBossCacheSource source,
059                              JBossCacheWorkspaces workspaces ) {
060            assert source != null;
061            assert workspaces != null;
062            this.source = source;
063            this.workspaces = workspaces;
064        }
065    
066        /**
067         * {@inheritDoc}
068         */
069        public String getSourceName() {
070            return source.getName();
071        }
072    
073        /**
074         * {@inheritDoc}
075         */
076        public CachePolicy getDefaultCachePolicy() {
077            return source.getDefaultCachePolicy();
078        }
079    
080        /**
081         * {@inheritDoc}
082         */
083        public XAResource getXAResource() {
084            return null;
085        }
086    
087        /**
088         * {@inheritDoc}
089         */
090        public boolean ping( long time,
091                             TimeUnit unit ) {
092            return true;
093        }
094    
095        /**
096         * {@inheritDoc}
097         */
098        public void setListener( RepositorySourceListener listener ) {
099            this.listener = listener != null ? listener : NO_OP_LISTENER;
100        }
101    
102        /**
103         * {@inheritDoc}
104         */
105        public void close() {
106            // do nothing
107        }
108    
109        /**
110         * {@inheritDoc}
111         * 
112         * @see org.jboss.dna.graph.connector.RepositoryConnection#execute(org.jboss.dna.graph.ExecutionContext,
113         *      org.jboss.dna.graph.request.Request)
114         */
115        public void execute( final ExecutionContext context,
116                             final Request request ) throws RepositorySourceException {
117            RequestProcessor processor = new JBossCacheRequestProcessor(getSourceName(), context, workspaces,
118                                                                        source.getNameOfDefaultWorkspace(),
119                                                                        source.isCreatingWorkspacesAllowed());
120            try {
121                processor.process(request);
122            } finally {
123                processor.close();
124            }
125        }
126    
127        /**
128         * @return listener
129         */
130        protected RepositorySourceListener getListener() {
131            return this.listener;
132        }
133    }