Class MemberListHandler

All Implemented Interfaces:
JcmsConstants, JaliosConstants
Direct Known Subclasses:
GroupMemberListHandler

public class MemberListHandler extends JcmsFormHandler
  • Field Details

    • EXPORT_CSV_MEMBER_JSP

      protected static final String EXPORT_CSV_MEMBER_JSP
      See Also:
    • EXPORT_CSV_DBMEMBER_JSP

      protected static final String EXPORT_CSV_DBMEMBER_JSP
      See Also:
    • IMPORT_CSV_MEMBER_JSP

      protected static final String IMPORT_CSV_MEMBER_JSP
      See Also:
    • IMPORT_CSV_PEOPLE_JSP

      protected static final String IMPORT_CSV_PEOPLE_JSP
      See Also:
    • GROUP_FILTER

      public static final String GROUP_FILTER
      See Also:
    • storage

      protected MemberListHandler.Storage storage
    • type

      protected MemberListHandler.Type type
    • state

      protected MemberListHandler.State state
    • insertMember

      protected Member insertMember
    • removeMember

      protected Member removeMember
    • selectedGroup

      protected Group selectedGroup
    • selectedMemberSet

      protected Set<Member> selectedMemberSet
    • opInsertMember

      protected boolean opInsertMember
    • opRemoveMember

      protected boolean opRemoveMember
    • workspaceFilter

      protected boolean workspaceFilter
    • qh

      protected AbstractMemberQueryHandler<? extends Member> qh
    • totalSize

      protected int totalSize
    • memberCollection

      protected Collection<? extends Member> memberCollection
    • text

      protected String text
    • queryString

      protected String queryString
    • queryDescription

      protected String queryDescription
    • tooManyResults

      protected boolean tooManyResults
    • missingCriteria

      protected boolean missingCriteria
    • displayResultNbr

      protected boolean displayResultNbr
    • canCreateMember

      protected boolean canCreateMember
    • wsPubSet

      protected Set<Publication> wsPubSet
  • Constructor Details

    • MemberListHandler

      public MemberListHandler()
  • Method Details

    • init

      protected void init()
      Description copied from class: JcmsFormHandler
      Method to implement if you need to initialize your handler from parameter received, prior to all security validation.

      You must absolutely not perform any action which modify data or site configuration.

      Therefore it is strongly recommend NOT TO implement this method, or use very wisely.

      Overrides:
      init in class JcmsFormHandler
    • appendUsageEvent

      protected void appendUsageEvent()
    • initQueryHandler

      public void initQueryHandler()
    • initAllMemberQueryHandler

      protected void initAllMemberQueryHandler()
    • initDBMemberQueryHandler

      protected void initDBMemberQueryHandler()
    • initMemberQueryHandler

      protected void initMemberQueryHandler()
    • getTitle

      public String getTitle()
    • processAction

      public boolean processAction() throws IOException
      Description copied from class: JcmsFormHandler
      Method to be implemented to check/validate action to be performed and process them.

      Default implementation is to return false. No need to call super method.

      This method may NOT be invoked at all if security validation are not met.

      You must ensure your handler and JSP can work properly without any code invoked in this method.

      Overrides:
      processAction in class JcmsFormHandler
      Returns:
      false if no redirection is needed, true otherwise
      Throws:
      IOException - IO Exception
    • validateInsertMember

      public boolean validateInsertMember()
    • performInsertMember

      public boolean performInsertMember() throws IOException
      Throws:
      IOException
    • validateRemoveMember

      public boolean validateRemoveMember()
    • performRemoveMember

      public boolean performRemoveMember() throws IOException
      Throws:
      IOException
    • setInsertMember

      public void setInsertMember(String insertMember)
      Parameters:
      insertMember - The insertMember to set.
    • setRemoveMember

      public void setRemoveMember(String removeMember)
      Parameters:
      removeMember - The removeMember to set.
    • setGid

      public void setGid(String gid)
    • getAvailableSelectedGroup

      public Group getAvailableSelectedGroup()
    • setMembers

      public void setMembers(String members)
    • getSelectedMemberSet

      public Set<Member> getSelectedMemberSet()
    • getQueryHandler

      public AbstractMemberQueryHandler<? extends Member> getQueryHandler()
    • setQueryHandler

      public void setQueryHandler(AbstractMemberQueryHandler qh)
    • getBreadcrumbItems

      public List<BreadcrumbItem> getBreadcrumbItems()
    • getSearchSettings

      public ControlSettings getSearchSettings()
    • getStorageSettings

      public ControlSettings getStorageSettings()
    • getTypeSettings

      public ControlSettings getTypeSettings()
    • getStateSettings

      public ControlSettings getStateSettings()
    • getClearanceLevelSettings

      public ControlSettings getClearanceLevelSettings()
    • getGroupSettings

      public ControlSettings getGroupSettings()
    • getWorkspaceSettings

      public ControlSettings getWorkspaceSettings()
    • showStateFilter

      public boolean showStateFilter()
    • showClearanceLevel

      public boolean showClearanceLevel()
    • showClearanceLevelFilter

      public boolean showClearanceLevelFilter()
    • showCreateMember

      public boolean showCreateMember()
    • getResultCountLabel

      public String getResultCountLabel()
    • getCreateMemberLabel

      public String getCreateMemberLabel()
    • getCreateMemberUrl

      public String getCreateMemberUrl()
    • showSyncLdap

      public boolean showSyncLdap()
    • showExportCsv

      public boolean showExportCsv()
    • getExportCsvUrl

      public String getExportCsvUrl()
      Returns an url for CSV export with current user filters.
      Relies on current MemberQueryHandler queryString, which is appended as HTTP parameters.
      Current user must be logged, and have right to export members.

      Example: returns an URL with search filters like:

      "admin/exportCSVMember.jsp?text=manager&usage=0&enabled=true"
      Returns:
      export list CSV url
      Since:
      jcms-10.0.7 JCMS-9515
    • showImportCsv

      public boolean showImportCsv()
    • getImportCsvUrl

      public String getImportCsvUrl()
    • showTypeFilter

      public boolean showTypeFilter()
    • showGuestFilter

      public boolean showGuestFilter()
    • showContactFilter

      public boolean showContactFilter()
    • showStorageFilter

      public boolean showStorageFilter()
    • getRights

      public String getRights(Member mbr)
    • setStorage

      public void setStorage(String v)
    • isMemberStorage

      public boolean isMemberStorage()
    • isDBMemberStorage

      public boolean isDBMemberStorage()
    • isAllMemberStorage

      public boolean isAllMemberStorage()
    • getTotalSize

      public int getTotalSize()
    • getMemberCollection

      public Collection<? extends Member> getMemberCollection()
    • getText

      public String getText()
    • getQueryString

      public String getQueryString()
    • getQueryDescription

      public String getQueryDescription()
    • getTooManyResults

      public boolean getTooManyResults()
    • getMissingCriteria

      public boolean getMissingCriteria()
    • getDisplayResultNbr

      public boolean getDisplayResultNbr()
    • isEnabledFilter

      public boolean isEnabledFilter()
    • isDisabledFilter

      public boolean isDisabledFilter()
    • isMemberFilter

      public boolean isMemberFilter()
    • isContactFilter

      public boolean isContactFilter()
    • isGuestFilter

      public boolean isGuestFilter()
    • getPubCount

      public int getPubCount(Member mbr)
    • setWorkspaceFilter

      public void setWorkspaceFilter(String v)
    • setType

      public void setType(String v)
    • setState

      public void setState(String v)