Package org.alfresco.module.aosmodule.dispatch

Class ListsService

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    public class ListsService
extends org.alfresco.officeservices.lists.AbstractListsService
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.alfresco.officeservices.UserData userData  

      • Fields inherited from class org.alfresco.officeservices.lists.AbstractListsService

        METHODNAME_CHECKINFILE, METHODNAME_CHECKOUTFILE, METHODNAME_GETATTACHMENTCOLLECTION, METHODNAME_GETLIST, METHODNAME_GETLISTANDVIEW, METHODNAME_GETLISTCOLLECTION, METHODNAME_GETLISTCONTENTTYPE, METHODNAME_GETLISTCONTENTTYPES, METHODNAME_GETLISTCONTENTTYPESANDPROPERTIES, METHODNAME_GETLISTITEMCHANGES, METHODNAME_GETLISTITEMCHANGESSINCETOKEN, METHODNAME_GETLISTITEMS, METHODNAME_UNDOCHECKOUT, METHODNAME_UPDATELISTITEMS, METHODPARAMETER_BATCH, METHODPARAMETER_CHANGETOKEN, METHODPARAMETER_CHECKINTYPE, METHODPARAMETER_CHECKOUTTOLOCAL, METHODPARAMETER_COMMENT, METHODPARAMETER_CONTAINS, METHODPARAMETER_CONTENTTYPEID, METHODPARAMETER_INCLUDEWEBPROPERTIES, METHODPARAMETER_LASTMODIFIED, METHODPARAMETER_LISTNAME, METHODPARAMETER_PAGEURL, METHODPARAMETER_PROPERTYPREFIX, METHODPARAMETER_QUERY, METHODPARAMETER_QUERYOPTIONS, METHODPARAMETER_ROWLIMIT, METHODPARAMETER_SINCE, METHODPARAMETER_UPDATES, METHODPARAMETER_VIEWFIELDS, METHODPARAMETER_VIEWNAME, RESPONSE_CONTENT_TYPE

      • Fields inherited from class org.alfresco.officeservices.AbstractSoapService

        threadLocalDateFormatSoap

    • Constructor Summary

      Constructors 
      Constructor Description
      ListsService()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean checkinFile​(org.alfresco.officeservices.UserData userData, java.lang.String documentName, java.lang.String comment, org.alfresco.officeservices.lists.CheckinType checkinType)  
      protected boolean checkoutFile​(org.alfresco.officeservices.UserData userData, java.lang.String documentName, boolean checkoutToLocal, java.lang.String lastModified)  
      protected java.lang.String getAlternateServerURL​(org.alfresco.officeservices.UserData userData, java.lang.String listName, javax.servlet.http.HttpServletRequest request)  
      protected org.alfresco.officeservices.lists.ListsGetListList getList​(org.alfresco.officeservices.UserData userData, java.lang.String listName, javax.servlet.http.HttpServletRequest request)  
      protected org.alfresco.officeservices.lists.ListChanges getListChangesSinceToken​(org.alfresco.officeservices.UserData userData, java.lang.String listName, org.alfresco.officeservices.protocol.SoapParameter viewFields, java.lang.String rowLimit, org.alfresco.officeservices.protocol.SoapParameter queryOptions, java.lang.String changeToken, org.alfresco.officeservices.protocol.SoapParameter contains, javax.servlet.http.HttpServletRequest request)  
      java.util.List<org.alfresco.officeservices.lists.ListDescription> getListCollection​(org.alfresco.officeservices.protocol.SimpleSoapParser parser)  
      protected org.alfresco.officeservices.lists.ListsGetListContentTypeContentType getListContentType​(org.alfresco.officeservices.UserData userData, java.lang.String listName, java.lang.String contentTypeId, javax.servlet.http.HttpServletRequest request)  
      protected org.alfresco.officeservices.lists.ListsGetListContentTypesContentType[] getListContentTypes​(org.alfresco.officeservices.UserData userData, java.lang.String listName, java.lang.String contentTypeId, javax.servlet.http.HttpServletRequest request)  
      protected org.alfresco.officeservices.lists.ListChanges getListItemChanges​(org.alfresco.officeservices.UserData userData, java.lang.String listName, java.lang.String since, javax.servlet.http.HttpServletRequest request)  
      protected org.alfresco.officeservices.lists.ListChanges getListItems​(org.alfresco.officeservices.UserData userData, java.lang.String listName, org.alfresco.officeservices.protocol.SoapParameter query, org.alfresco.officeservices.protocol.SoapParameter queryOptions, org.alfresco.officeservices.protocol.SoapParameter viewFields, javax.servlet.http.HttpServletRequest request)  
      protected org.alfresco.officeservices.lists.ListType getListType​(org.alfresco.officeservices.UserData userData, java.lang.String listName)  
      protected java.lang.String getRootFolder​(org.alfresco.officeservices.UserData userData, java.lang.String listName)  
      protected org.alfresco.officeservices.lists.ListsGetListAndViewView getView​(org.alfresco.officeservices.UserData userData, java.lang.String listName, java.lang.String viewName, javax.servlet.http.HttpServletRequest request)  
      void invalidateAuthentication​(org.alfresco.officeservices.UserData userData, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      protected boolean isValidListName​(org.alfresco.officeservices.UserData userData, java.lang.String listName)  
      protected boolean isWSS3List​(org.alfresco.officeservices.UserData userData, java.lang.String listName)  
      org.alfresco.officeservices.UserData negotiateAuthentication​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      void requestAuthentication​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      protected boolean undoCheckOut​(org.alfresco.officeservices.UserData userData, java.lang.String documentName)  
      protected org.alfresco.officeservices.lists.UpdateListItemsResults updateListItems​(org.alfresco.officeservices.UserData userData, java.lang.String listName, org.alfresco.officeservices.lists.ListUpdatesBatch batch, javax.servlet.http.HttpServletRequest request)  

      • Methods inherited from class org.alfresco.officeservices.lists.AbstractListsService

        getSitePrefix, handleCheckInFile, handleCheckOutFile, handleGetList, handleGetListAndView, handleGetListCollection, handleGetListContentType, handleGetListContentTypes, handleGetListContentTypesAndProperties, handleGetListItemChanges, handleGetListItemChangesSinceToken, handleGetListItems, handleUndoCheckOut, handleUpdateListItems, soapService, writeFieldElement, writeListElement

      • Methods inherited from class org.alfresco.officeservices.AbstractSoapService

        doPost, formatDate, getThreadDateFormatSoap, parseDate, writeEncoded, writeEncoded2, writeXmlAttribute

      • Methods inherited from class javax.servlet.http.HttpServlet

        doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

      • Methods inherited from class javax.servlet.GenericServlet

        destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • userData

        protected org.alfresco.officeservices.UserData userData

    • Constructor Detail

      • ListsService

        public ListsService()

    • Method Detail

      • isWSS3List

        protected boolean isWSS3List​(org.alfresco.officeservices.UserData userData,
                             java.lang.String listName)
        Specified by:
        isWSS3List in class org.alfresco.officeservices.lists.AbstractListsService

      • getListType

        protected org.alfresco.officeservices.lists.ListType getListType​(org.alfresco.officeservices.UserData userData,
                                                                 java.lang.String listName)
        Specified by:
        getListType in class org.alfresco.officeservices.lists.AbstractListsService

      • isValidListName

        protected boolean isValidListName​(org.alfresco.officeservices.UserData userData,
                                  java.lang.String listName)
        Specified by:
        isValidListName in class org.alfresco.officeservices.lists.AbstractListsService

      • getAlternateServerURL

        protected java.lang.String getAlternateServerURL​(org.alfresco.officeservices.UserData userData,
                                                 java.lang.String listName,
                                                 javax.servlet.http.HttpServletRequest request)
        Specified by:
        getAlternateServerURL in class org.alfresco.officeservices.lists.AbstractListsService

      • getRootFolder

        protected java.lang.String getRootFolder​(org.alfresco.officeservices.UserData userData,
                                         java.lang.String listName)
        Specified by:
        getRootFolder in class org.alfresco.officeservices.lists.AbstractListsService

      • getListItemChanges

        protected org.alfresco.officeservices.lists.ListChanges getListItemChanges​(org.alfresco.officeservices.UserData userData,
                                                                           java.lang.String listName,
                                                                           java.lang.String since,
                                                                           javax.servlet.http.HttpServletRequest request)
                                                                    throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getListItemChanges in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • getListItems

        protected org.alfresco.officeservices.lists.ListChanges getListItems​(org.alfresco.officeservices.UserData userData,
                                                                     java.lang.String listName,
                                                                     org.alfresco.officeservices.protocol.SoapParameter query,
                                                                     org.alfresco.officeservices.protocol.SoapParameter queryOptions,
                                                                     org.alfresco.officeservices.protocol.SoapParameter viewFields,
                                                                     javax.servlet.http.HttpServletRequest request)
                                                              throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getListItems in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • updateListItems

        protected org.alfresco.officeservices.lists.UpdateListItemsResults updateListItems​(org.alfresco.officeservices.UserData userData,
                                                                                   java.lang.String listName,
                                                                                   org.alfresco.officeservices.lists.ListUpdatesBatch batch,
                                                                                   javax.servlet.http.HttpServletRequest request)
                                                                            throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        updateListItems in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • getListChangesSinceToken

        protected org.alfresco.officeservices.lists.ListChanges getListChangesSinceToken​(org.alfresco.officeservices.UserData userData,
                                                                                 java.lang.String listName,
                                                                                 org.alfresco.officeservices.protocol.SoapParameter viewFields,
                                                                                 java.lang.String rowLimit,
                                                                                 org.alfresco.officeservices.protocol.SoapParameter queryOptions,
                                                                                 java.lang.String changeToken,
                                                                                 org.alfresco.officeservices.protocol.SoapParameter contains,
                                                                                 javax.servlet.http.HttpServletRequest request)
                                                                          throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getListChangesSinceToken in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • checkoutFile

        protected boolean checkoutFile​(org.alfresco.officeservices.UserData userData,
                               java.lang.String documentName,
                               boolean checkoutToLocal,
                               java.lang.String lastModified)
                        throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        checkoutFile in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • checkinFile

        protected boolean checkinFile​(org.alfresco.officeservices.UserData userData,
                              java.lang.String documentName,
                              java.lang.String comment,
                              org.alfresco.officeservices.lists.CheckinType checkinType)
                       throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        checkinFile in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • undoCheckOut

        protected boolean undoCheckOut​(org.alfresco.officeservices.UserData userData,
                               java.lang.String documentName)
                        throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        undoCheckOut in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • getListContentType

        protected org.alfresco.officeservices.lists.ListsGetListContentTypeContentType getListContentType​(org.alfresco.officeservices.UserData userData,
                                                                                                  java.lang.String listName,
                                                                                                  java.lang.String contentTypeId,
                                                                                                  javax.servlet.http.HttpServletRequest request)
                                                                                           throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getListContentType in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • getListContentTypes

        protected org.alfresco.officeservices.lists.ListsGetListContentTypesContentType[] getListContentTypes​(org.alfresco.officeservices.UserData userData,
                                                                                                      java.lang.String listName,
                                                                                                      java.lang.String contentTypeId,
                                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                                               throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getListContentTypes in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • getListCollection

        public java.util.List<org.alfresco.officeservices.lists.ListDescription> getListCollection​(org.alfresco.officeservices.protocol.SimpleSoapParser parser)
        Specified by:
        getListCollection in class org.alfresco.officeservices.lists.AbstractListsService

      • getList

        protected org.alfresco.officeservices.lists.ListsGetListList getList​(org.alfresco.officeservices.UserData userData,
                                                                     java.lang.String listName,
                                                                     javax.servlet.http.HttpServletRequest request)
                                                              throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getList in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • getView

        protected org.alfresco.officeservices.lists.ListsGetListAndViewView getView​(org.alfresco.officeservices.UserData userData,
                                                                            java.lang.String listName,
                                                                            java.lang.String viewName,
                                                                            javax.servlet.http.HttpServletRequest request)
                                                                     throws org.alfresco.officeservices.exceptions.AuthenticationRequiredException
        Specified by:
        getView in class org.alfresco.officeservices.lists.AbstractListsService
        Throws:
        org.alfresco.officeservices.exceptions.AuthenticationRequiredException

      • negotiateAuthentication

        public org.alfresco.officeservices.UserData negotiateAuthentication​(javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response)
                                                             throws java.io.IOException
        Specified by:
        negotiateAuthentication in class org.alfresco.officeservices.AbstractSoapService
        Throws:
        java.io.IOException

      • requestAuthentication

        public void requestAuthentication​(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws java.io.IOException
        Specified by:
        requestAuthentication in class org.alfresco.officeservices.AbstractSoapService
        Throws:
        java.io.IOException

      • invalidateAuthentication

        public void invalidateAuthentication​(org.alfresco.officeservices.UserData userData,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws java.io.IOException
        Specified by:
        invalidateAuthentication in class org.alfresco.officeservices.AbstractSoapService
        Throws:
        java.io.IOException