Package com.jalios.jcms.handler

Class MemberListHandler

  • All Implemented Interfaces:
    JcmsConstants, JaliosConstants
    public class MemberListHandler
extends JcmsFormHandler
    This form handler processes admin/memberList.jsp form in administration area.
    Version:
    $Revision: 135673 $
    Author:
    Jean-Philippe Encausse

    • Field Detail

      • EXPORT_CSV_MEMBER_JSP

        protected static final java.lang.String EXPORT_CSV_MEMBER_JSP
        See Also:
        Constant Field Values

      • EXPORT_CSV_DBMEMBER_JSP

        protected static final java.lang.String EXPORT_CSV_DBMEMBER_JSP
        See Also:
        Constant Field Values

      • IMPORT_CSV_MEMBER_JSP

        protected static final java.lang.String IMPORT_CSV_MEMBER_JSP
        See Also:
        Constant Field Values

      • insertMember

        protected Member insertMember

      • removeMember

        protected Member removeMember

      • selectedGroup

        protected Group selectedGroup

      • selectedMemberSet

        protected java.util.Set<Member> selectedMemberSet

      • op

        protected boolean op

      • opInsertMember

        protected boolean opInsertMember

      • opRemoveMember

        protected boolean opRemoveMember

    • Constructor Detail

      • MemberListHandler

        public MemberListHandler()

    • Method Detail

      • processAction

        public boolean processAction()
                      throws java.io.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:
        java.io.IOException - IO Exception

      • validateInsertMember

        public boolean validateInsertMember()

      • performInsertMember

        public boolean performInsertMember()
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • validateRemoveMember

        public boolean validateRemoveMember()

      • performRemoveMember

        public boolean performRemoveMember()
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • setInsertMember

        public void setInsertMember​(java.lang.String insertMember)
        Parameters:
        insertMember - The insertMember to set.

      • setRemoveMember

        public void setRemoveMember​(java.lang.String removeMember)
        Parameters:
        removeMember - The removeMember to set.

      • setGid

        public void setGid​(java.lang.String gid)

      • getAvailableSelectedGroup

        public Group getAvailableSelectedGroup()

      • setMembers

        public void setMembers​(java.lang.String members)

      • getSelectedMemberSet

        public java.util.Set<Member> getSelectedMemberSet()

      • setMemberQueryHandler

        public void setMemberQueryHandler​(AbstractMemberQueryHandler<Member> memberQueryHandler)
        Parameters:
        memberQueryHandler - the memberQueryHandler to set

      • getExportCsvUrl

        public java.lang.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

      • getExportCsvFilename

        public static java.lang.String getExportCsvFilename​(java.lang.String dataType)
        Parameters:
        dataType - type of Member (member or dbmember)
        Returns:
        the name to set on generated CSV file
        Since:
        10.0.7

      • getImportCsvUrl

        public java.lang.String getImportCsvUrl​(Group wsGroup,
                                        boolean dbMember)
        Returns an url for CSV import with current gid parameter.
        Parameters:
        wsGroup - optional gid filtered group
        dbMember - type of import, jstore or db
        Returns:
        members CSV import url
        Since:
        10.0.7

      • getRights

        public java.lang.String getRights​(Member mbr)