git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   2  * OrgAuthorityClient.java
   3  *
   4  * {Purpose of This Class}
   5  *
   6  * {Other Notes Relating to This Class (Optional)}
   7  *
   8  * $LastChangedBy: $
   9  * $LastChangedRevision: $
  10  * $LastChangedDate: $
  11  *
  12  * This document is a part of the source code and related artifacts
  13  * for CollectionSpace, an open source collections management system
  14  * for museums and related institutions:
  15  *
  16  * http://www.collectionspace.org
  17  * http://wiki.collectionspace.org
  18  *
  19  * Copyright © 2009 {Contributing Institution}
  20  *
  21  * Licensed under the Educational Community License (ECL), Version 2.0.
  22  * You may not use this file except in compliance with this License.
  23  *
  24  * You may obtain a copy of the ECL 2.0 License at
  25  * https://source.collectionspace.org/collection-space/LICENSE.txt
  26  */
  27 package org.collectionspace.services.client;
  28
  29 //import javax.ws.rs.PathParam;
  30 import javax.ws.rs.core.Response;
  31
  32 import org.collectionspace.services.common.authorityref.AuthorityRefDocList;
  33 import org.collectionspace.services.common.authorityref.AuthorityRefList;
  34 import org.collectionspace.services.contact.ContactsCommonList;
  35 import org.collectionspace.services.organization.OrgauthoritiesCommonList;
  36 import org.collectionspace.services.organization.OrganizationsCommonList;
  37
  38 import org.jboss.resteasy.client.ClientResponse;
  39 import org.jboss.resteasy.client.ProxyFactory;
  40 import org.jboss.resteasy.plugins.providers.RegisterBuiltin;
  41 import org.jboss.resteasy.plugins.providers.multipart.MultipartInput;
  42 import org.jboss.resteasy.plugins.providers.multipart.MultipartOutput;
  43 import org.jboss.resteasy.spi.ResteasyProviderFactory;
  44
  45 /**
  46  * The Class OrgAuthorityClient.
  47  */
  48 public class OrgAuthorityClient extends AbstractServiceClientImpl {
  49
  50     /* (non-Javadoc)
  51      * @see org.collectionspace.services.client.AbstractServiceClientImpl#getServicePathComponent()
  52      */
  53     @Override
  54     public String getServicePathComponent() {
  55         return "orgauthorities";
  56     }
  57
  58     /**
  59      * Gets the item common part name.
  60      *
  61      * @return the item common part name
  62      */
  63     public String getItemCommonPartName() {
  64         return getCommonPartName("organizations");
  65     }
  66
  67     /** The Constant instance. */  //FIXME: This is wrong.  There should NOT be a static instance of the OrgAuthorityClient class
  68 //    private static final OrgAuthorityClient instance = new OrgAuthorityClient();
  69
  70     /** The org authority proxy. */
  71     private OrgAuthorityProxy orgAuthorityProxy;
  72
  73     /**
  74      * Instantiates a new org authority client.
  75      */
  76     public OrgAuthorityClient() {
  77         ResteasyProviderFactory factory = ResteasyProviderFactory.getInstance();
  78         RegisterBuiltin.register(factory);
  79         setProxy();
  80     }
  81
  82     /* (non-Javadoc)
  83      * @see org.collectionspace.services.client.CollectionSpaceClient#getProxy()
  84      */
  85     @Override
  86     public CollectionSpaceProxy getProxy() {
  87         return this.orgAuthorityProxy;
  88     }
  89
  90     /**
  91      * Sets the proxy.
  92      */
  93     public void setProxy() {
  94         if (useAuth()) {
  95             orgAuthorityProxy = ProxyFactory.create(OrgAuthorityProxy.class,
  96                     getBaseURL(), getHttpClient());
  97         } else {
  98             orgAuthorityProxy = ProxyFactory.create(OrgAuthorityProxy.class,
  99                     getBaseURL());
 100         }
 101     }
 102
 103     /**
 104      * Gets the single instance of OrgAuthorityClient.
 105      *
 106      * @return single instance of OrgAuthorityClient //FIXME: This is wrong.  There should NOT be a static instance of the client
 107      */
 108 //    public static OrgAuthorityClient getInstance() {
 109 //        return instance;
 110 //    }
 111
 112     /**
 113      * Read list.
 114      *
 115      * @return the client response
 116      */
 117     public ClientResponse<OrgauthoritiesCommonList> readList() {
 118         return orgAuthorityProxy.readList();
 119     }
 120
 121     /**
 122      * Read.
 123      *
 124      * @param csid the csid
 125      * @return the client response
 126      */
 127     public ClientResponse<MultipartInput> read(String csid) {
 128         return orgAuthorityProxy.read(csid);
 129     }
 130
 131     /**
 132      * Read by name.
 133      *
 134      * @param name the name
 135      * @return the client response
 136      */
 137     public ClientResponse<MultipartInput> readByName(String name) {
 138         return orgAuthorityProxy.readByName(name);
 139     }
 140
 141     /**
 142      * Creates the.
 143      *
 144      * @param multipart the multipart
 145      * @return the client response
 146      */
 147     public ClientResponse<Response> create(MultipartOutput multipart) {
 148         return orgAuthorityProxy.create(multipart);
 149     }
 150
 151     /**
 152      * Update.
 153      *
 154      * @param csid the csid
 155      * @param multipart the multipart
 156      * @return the client response
 157      */
 158     public ClientResponse<MultipartInput> update(String csid, MultipartOutput multipart) {
 159         return orgAuthorityProxy.update(csid, multipart);
 160
 161     }
 162
 163     /**
 164      * Delete.
 165      *
 166      * @param csid the csid
 167      * @return the client response
 168      */
 169     @Override
 170     public ClientResponse<Response> delete(String csid) {
 171         return orgAuthorityProxy.delete(csid);
 172     }
 173
 174     /**
 175      * Read item list.
 176      *
 177      * @param vcsid the vcsid
 178      * @return the client response
 179      */
 180     public ClientResponse<OrganizationsCommonList> readItemList(String vcsid) {
 181         return orgAuthorityProxy.readItemList(vcsid);
 182     }
 183
 184     /**
 185      * Gets the referencing objects.
 186      *
 187      * @param parentcsid the parentcsid
 188      * @param csid the csid
 189      * @return the referencing objects
 190      */
 191     public ClientResponse<AuthorityRefDocList> getReferencingObjects(String parentcsid, String csid) {
 192         return orgAuthorityProxy.getReferencingObjects(parentcsid, csid);
 193     }
 194
 195
 196     /**
 197      * Read item list for named authority.
 198      *
 199      * @param specifier the specifier
 200      * @return the client response
 201      */
 202     public ClientResponse<OrganizationsCommonList> readItemListForNamedAuthority(String specifier) {
 203         return orgAuthorityProxy.readItemListForNamedAuthority(specifier);
 204     }
 205
 206     /**
 207      * Gets the item authority refs.
 208      *
 209      * @param parentcsid the parentcsid
 210      * @param csid the csid
 211      * @return the item authority refs
 212      */
 213     public ClientResponse<AuthorityRefList> getItemAuthorityRefs(String parentcsid, String csid) {
 214         return orgAuthorityProxy.getItemAuthorityRefs(parentcsid, csid);
 215     }
 216
 217     /**
 218      * Read item.
 219      *
 220      * @param vcsid the vcsid
 221      * @param csid the csid
 222      * @return the client response
 223      */
 224     public ClientResponse<MultipartInput> readItem(String vcsid, String csid) {
 225         return orgAuthorityProxy.readItem(vcsid, csid);
 226     }
 227
 228     /**
 229      * Read named item.
 230      *
 231      * @param vcsid the vcsid
 232      * @param shortId the shortIdentifier
 233      * @return the client response
 234      */
 235     public ClientResponse<MultipartInput> readNamedItem(String vcsid, String shortId) {
 236         return orgAuthorityProxy.readNamedItem(vcsid, shortId);
 237     }
 238
 239     /**
 240      * Read item in Named Authority.
 241      *
 242      * @param authShortId the shortIdentifier for the Authority
 243      * @param csid the csid
 244      * @return the client response
 245      */
 246     public ClientResponse<MultipartInput> readItemInNamedAuthority(String authShortId, String csid) {
 247         return orgAuthorityProxy.readItemInNamedAuthority(authShortId, csid);
 248     }
 249
 250     /**
 251      * Read named item in Named Authority.
 252      *
 253      * @param authShortId the shortIdentifier for the Authority
 254      * @param itemShortId the shortIdentifier for the item
 255      * @return the client response
 256      */
 257     public ClientResponse<MultipartInput> readNamedItemInNamedAuthority(String authShortId, String itemShortId) {
 258         return orgAuthorityProxy.readNamedItem(authShortId, itemShortId);
 259     }
 260
 261     /**
 262      * Creates the item.
 263      *
 264      * @param vcsid the vcsid
 265      * @param multipart the multipart
 266      * @return the client response
 267      */
 268     public ClientResponse<Response> createItem(String vcsid, MultipartOutput multipart) {
 269         return orgAuthorityProxy.createItem(vcsid, multipart);
 270     }
 271
 272     /**
 273      * Update item.
 274      *
 275      * @param vcsid the vcsid
 276      * @param csid the csid
 277      * @param multipart the multipart
 278      * @return the client response
 279      */
 280     public ClientResponse<MultipartInput> updateItem(String vcsid, String csid, MultipartOutput multipart) {
 281         return orgAuthorityProxy.updateItem(vcsid, csid, multipart);
 282
 283     }
 284
 285     /**
 286      * Delete item.
 287      *
 288      * @param vcsid the vcsid
 289      * @param csid the csid
 290      * @return the client response
 291      */
 292     public ClientResponse<Response> deleteItem(String vcsid, String csid) {
 293         return orgAuthorityProxy.deleteItem(vcsid, csid);
 294     }
 295
 296     /**
 297      * Creates the contact.
 298      *
 299      * @param parentcsid the parentcsid
 300      * @param itemcsid the itemcsid
 301      * @param multipart the multipart
 302      * @return the client response
 303      */
 304     public ClientResponse<Response> createContact(String parentcsid,
 305             String itemcsid, MultipartOutput multipart) {
 306         return orgAuthorityProxy.createContact(parentcsid, itemcsid, multipart);
 307     }
 308
 309     /**
 310      * Read contact.
 311      *
 312      * @param parentcsid the parentcsid
 313      * @param itemcsid the itemcsid
 314      * @param csid the csid
 315      * @return the client response
 316      */
 317     public ClientResponse<MultipartInput> readContact(String parentcsid,
 318             String itemcsid, String csid) {
 319         return orgAuthorityProxy.readContact(parentcsid, itemcsid, csid);
 320     }
 321
 322     /**
 323      * Read contact list.
 324      *
 325      * @param parentcsid the parentcsid
 326      * @param itemcsid the itemcsid
 327      * @return the client response
 328      */
 329     public ClientResponse<ContactsCommonList> readContactList(String parentcsid,
 330             String itemcsid) {
 331         return orgAuthorityProxy.readContactList(parentcsid, itemcsid);
 332     }
 333
 334     /**
 335      * Update contact.
 336      *
 337      * @param parentcsid the parentcsid
 338      * @param itemcsid the itemcsid
 339      * @param csid the csid
 340      * @param multipart the multipart
 341      * @return the client response
 342      */
 343     public ClientResponse<MultipartInput> updateContact(String parentcsid,
 344             String itemcsid, String csid, MultipartOutput multipart) {
 345         return orgAuthorityProxy.updateContact(parentcsid, itemcsid, csid, multipart);
 346     }
 347
 348     /**
 349      * Delete contact.
 350      *
 351      * @param parentcsid the parentcsid
 352      * @param itemcsid the itemcsid
 353      * @param csid the csid
 354      * @return the client response
 355      */
 356     public ClientResponse<Response> deleteContact(String parentcsid,
 357         String itemcsid, String csid) {
 358         return orgAuthorityProxy.deleteContact(parentcsid,
 359             itemcsid, csid);
 360     }
 361
 362 }