From 2bd3929110b32064b04b7ff4b323b02f9babe520 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Fri, 13 May 2011 17:50:45 +0200 Subject: [PATCH] added AbstractClientHandler --- .../scm/client/AbstractClientHandler.java | 314 ++++++++++++++++++ .../client/JerseyRepositoryClientHandler.java | 246 ++++---------- 2 files changed, 372 insertions(+), 188 deletions(-) create mode 100644 scm-clients/scm-client-impl/src/main/java/sonia/scm/client/AbstractClientHandler.java diff --git a/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/AbstractClientHandler.java b/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/AbstractClientHandler.java new file mode 100644 index 0000000000..56ca60e3bb --- /dev/null +++ b/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/AbstractClientHandler.java @@ -0,0 +1,314 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.client; + +//~--- non-JDK imports -------------------------------------------------------- + +import sonia.scm.ModelObject; +import sonia.scm.util.AssertUtil; + +//~--- JDK imports ------------------------------------------------------------ + +import com.sun.jersey.api.client.Client; +import com.sun.jersey.api.client.ClientResponse; +import com.sun.jersey.api.client.GenericType; +import com.sun.jersey.api.client.WebResource; + +import java.util.List; + +/** + * + * @author Sebastian Sdorra + * + * @param + */ +public abstract class AbstractClientHandler + implements ClientHandler +{ + + /** + * Constructs ... + * + * + * @param session + * @param itemClass + */ + public AbstractClientHandler(JerseyClientSession session, Class itemClass) + { + this.session = session; + this.itemClass = itemClass; + this.client = session.getClient(); + this.urlProvider = session.getUrlProvider(); + } + + //~--- methods -------------------------------------------------------------- + + /** + * Method description + * + * + * + * @return + */ + protected abstract GenericType> createGenericListType(); + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @param itemId + * + * @return + */ + protected abstract String getItemUrl(String itemId); + + /** + * Method description + * + * + * @return + */ + protected abstract String getItemsUrl(); + + //~--- methods -------------------------------------------------------------- + + /** + * Method description + * + * + * @param item + */ + @Override + public void create(T item) + { + AssertUtil.assertIsNotNull(item); + + WebResource resource = client.resource(getItemsUrl()); + ClientResponse response = null; + + try + { + response = resource.post(ClientResponse.class, item); + ClientUtil.checkResponse(response, 201); + postCreate(response, item); + } + finally + { + ClientUtil.close(response); + } + } + + /** + * Method description + * + * + * @param id + */ + @Override + public void delete(String id) + { + AssertUtil.assertIsNotEmpty(id); + + WebResource resource = client.resource(getItemUrl(id)); + ClientResponse response = null; + + try + { + response = resource.delete(ClientResponse.class); + ClientUtil.checkResponse(response, 204); + } + finally + { + ClientUtil.close(response); + } + } + + /** + * Method description + * + * + * @param item + */ + @Override + public void delete(T item) + { + AssertUtil.assertIsNotNull(item); + delete(item.getId()); + } + + /** + * Method description + * + * + * @param item + */ + @Override + public void modify(T item) + { + AssertUtil.assertIsNotNull(item); + + String id = item.getId(); + + AssertUtil.assertIsNotEmpty(id); + + WebResource resource = client.resource(getItemUrl(id)); + ClientResponse response = null; + + try + { + response = resource.put(ClientResponse.class, item); + ClientUtil.checkResponse(response, 204); + postModify(response, item); + } + finally + { + ClientUtil.close(response); + } + } + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @param id + * + * @return + */ + @Override + public T get(String id) + { + return getItemByUrl(getItemUrl(id)); + } + + /** + * Method description + * + * + * @return + */ + @Override + public List getAll() + { + List items = null; + WebResource resource = client.resource(getItemsUrl()); + ClientResponse response = null; + + try + { + response = resource.get(ClientResponse.class); + ClientUtil.checkResponse(response, 200); + items = response.getEntity(createGenericListType()); + } + finally + { + ClientUtil.close(response); + } + + return items; + } + + //~--- methods -------------------------------------------------------------- + + /** + * Method description + * + * + * @param response + * @param item + */ + protected void postCreate(ClientResponse response, T item) {} + + /** + * Method description + * + * + * @param response + * @param item + */ + protected void postModify(ClientResponse response, T item) {} + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @param url + * + * @return + */ + protected T getItemByUrl(String url) + { + T item = null; + WebResource resource = client.resource(url); + ClientResponse response = null; + + try + { + response = resource.get(ClientResponse.class); + + int sc = response.getStatus(); + + if (sc != ScmClientException.SC_NOTFOUND) + { + ClientUtil.checkResponse(response, 200); + item = response.getEntity(itemClass); + } + } + finally + { + ClientUtil.close(response); + } + + return item; + } + + //~--- fields --------------------------------------------------------------- + + /** Field description */ + protected Client client; + + /** Field description */ + protected JerseyClientSession session; + + /** Field description */ + protected ScmUrlProvider urlProvider; + + /** Field description */ + private Class itemClass; +} diff --git a/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/JerseyRepositoryClientHandler.java b/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/JerseyRepositoryClientHandler.java index 7a06fb4bb5..2797e8eeee 100644 --- a/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/JerseyRepositoryClientHandler.java +++ b/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/JerseyRepositoryClientHandler.java @@ -41,10 +41,8 @@ import sonia.scm.util.AssertUtil; //~--- JDK imports ------------------------------------------------------------ -import com.sun.jersey.api.client.Client; import com.sun.jersey.api.client.ClientResponse; import com.sun.jersey.api.client.GenericType; -import com.sun.jersey.api.client.WebResource; import java.util.Collection; import java.util.List; @@ -53,7 +51,9 @@ import java.util.List; * * @author Sebastian Sdorra */ -public class JerseyRepositoryClientHandler implements RepositoryClientHandler +public class JerseyRepositoryClientHandler + extends AbstractClientHandler + implements RepositoryClientHandler { /** @@ -64,161 +64,11 @@ public class JerseyRepositoryClientHandler implements RepositoryClientHandler */ public JerseyRepositoryClientHandler(JerseyClientSession session) { - this.session = session; - this.client = session.getClient(); - this.urlProvider = session.getUrlProvider(); - } - - //~--- methods -------------------------------------------------------------- - - /** - * Method description - * - * - * @param repository - */ - @Override - public void create(Repository repository) - { - AssertUtil.assertIsNotNull(repository); - - WebResource resource = client.resource(urlProvider.getRepositoriesUrl()); - ClientResponse response = null; - - try - { - response = resource.post(ClientResponse.class, repository); - ClientUtil.checkResponse(response, 201); - - String url = response.getHeaders().get("Location").get(0); - - AssertUtil.assertIsNotEmpty(url); - - Repository newRepository = getRepository(url); - - AssertUtil.assertIsNotNull(newRepository); - newRepository.copyProperties(repository); - - // copyProperties does not copy the repository id - repository.setId(newRepository.getId()); - } - finally - { - ClientUtil.close(response); - } - } - - /** - * Method description - * - * - * @param id - */ - @Override - public void delete(String id) - { - AssertUtil.assertIsNotEmpty(id); - - WebResource resource = client.resource(urlProvider.getRepositoryUrl(id)); - ClientResponse response = null; - - try - { - response = resource.delete(ClientResponse.class); - ClientUtil.checkResponse(response, 204); - } - finally - { - ClientUtil.close(response); - } - } - - /** - * Method description - * - * - * @param repository - */ - @Override - public void delete(Repository repository) - { - AssertUtil.assertIsNotNull(repository); - delete(repository.getId()); - } - - /** - * Method description - * - * - * @param repository - */ - @Override - public void modify(Repository repository) - { - AssertUtil.assertIsNotNull(repository); - - String id = repository.getId(); - - AssertUtil.assertIsNotEmpty(id); - - WebResource resource = client.resource(urlProvider.getRepositoryUrl(id)); - ClientResponse response = null; - - try - { - response = resource.put(ClientResponse.class, repository); - ClientUtil.checkResponse(response, 204); - } - finally - { - ClientUtil.close(response); - } + super(session, Repository.class); } //~--- get methods ---------------------------------------------------------- - /** - * Method description - * - * - * @param id - * - * @return - */ - @Override - public Repository get(String id) - { - return getRepository(urlProvider.getRepositoryUrl(id)); - } - - /** - * Method description - * - * - * @return - */ - @Override - public List getAll() - { - List repositories = null; - WebResource resource = client.resource(urlProvider.getRepositoriesUrl()); - ClientResponse response = null; - - try - { - response = resource.get(ClientResponse.class); - ClientUtil.checkResponse(response, 200); - repositories = response.getEntity(new GenericType>() {} - ); - } - finally - { - ClientUtil.close(response); - } - - return repositories; - } - /** * Method description * @@ -231,48 +81,68 @@ public class JerseyRepositoryClientHandler implements RepositoryClientHandler return session.getState().getRepositoryTypes(); } + //~--- methods -------------------------------------------------------------- + /** * Method description * * - * @param url + * @return + */ + @Override + protected GenericType> createGenericListType() + { + return new GenericType>() {}; + } + + /** + * Method description + * + * + * @param response + * @param repository + */ + @Override + protected void postCreate(ClientResponse response, Repository repository) + { + String url = response.getHeaders().get("Location").get(0); + + AssertUtil.assertIsNotEmpty(url); + + Repository newRepository = getItemByUrl(url); + + AssertUtil.assertIsNotNull(newRepository); + newRepository.copyProperties(repository); + + // copyProperties does not copy the repository id + repository.setId(newRepository.getId()); + } + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @param itemId * * @return */ - private Repository getRepository(String url) + @Override + protected String getItemUrl(String itemId) { - Repository repository = null; - WebResource resource = client.resource(url); - ClientResponse response = null; - - try - { - response = resource.get(ClientResponse.class); - - int sc = response.getStatus(); - - if (sc != ScmClientException.SC_NOTFOUND) - { - ClientUtil.checkResponse(response, 200); - repository = response.getEntity(Repository.class); - } - } - finally - { - ClientUtil.close(response); - } - - return repository; + return urlProvider.getRepositoryUrl(itemId); } - //~--- fields --------------------------------------------------------------- - - /** Field description */ - private Client client; - - /** Field description */ - private JerseyClientSession session; - - /** Field description */ - private ScmUrlProvider urlProvider; + /** + * Method description + * + * + * @return + */ + @Override + protected String getItemsUrl() + { + return urlProvider.getRepositoriesUrl(); + } }