org.nuxeo.ecm.platform.groups.audit.service.acl

Class AclExcelLayoutBuilder

java.lang.Object

org.nuxeo.ecm.platform.groups.audit.service.acl.AclExcelLayoutBuilder

All Implemented Interfaces:

IAclExcelLayoutBuilder

Direct Known Subclasses:

AclExcelLayoutBuilderMultiColumn

public class AclExcelLayoutBuilder
extends Object
implements IAclExcelLayoutBuilder

A builder works in three phases:

• Fetch documents, possibly using paging.
• Extract a document summary for each document.
• Render documents' summary:
  • Render header and define column layout
  • Render file tree and define row layout
  • Render ACL matrix

One can apply a IContentFilter to ignore some users/groups. This report builder uses one column per user, and write the list of existing ACL in one cell, by using "," as separator character. A denying ACL is indicated by !S, where S is the short name given to the ACL, as stated by the AclNameShortner.

Author:

Martin Pernollet

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_COL
static int	STATUS_ROW

Constructor Summary

Constructors

Constructor and Description
AclExcelLayoutBuilder()
AclExcelLayoutBuilder(IContentFilter filter)
AclExcelLayoutBuilder(ReportLayoutSettings layout)
AclExcelLayoutBuilder(ReportLayoutSettings layout, IContentFilter filter)

Method Summary

Methods

Modifier and Type	Method and Description
static ReportLayoutSettings	defaultLayout()
IExcelBuilder	getExcel()
void	renderAudit(CoreSession session) Analyze and render an ACL audit for the complete repository in unrestricted mode.
void	renderAudit(CoreSession session, DocumentModel doc) Analyze and render an ACL audit for the complete document tree in unrestricted mode.
void	renderAudit(CoreSession session, DocumentModel doc, boolean unrestricted) Analyze and render an ACL audit for the input document and its children.
void	renderAudit(CoreSession session, DocumentModel doc, boolean unrestricted, int timeout)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_ROW

public static int STATUS_ROW

STATUS_COL

public static int STATUS_COL

Constructor Detail

AclExcelLayoutBuilder

public AclExcelLayoutBuilder()

AclExcelLayoutBuilder

public AclExcelLayoutBuilder(IContentFilter filter)

AclExcelLayoutBuilder

public AclExcelLayoutBuilder(ReportLayoutSettings layout)

AclExcelLayoutBuilder

public AclExcelLayoutBuilder(ReportLayoutSettings layout,
                     IContentFilter filter)

Method Detail

defaultLayout

public static ReportLayoutSettings defaultLayout()

renderAudit

public void renderAudit(CoreSession session)
                 throws ClientException

Description copied from interface: IAclExcelLayoutBuilder

Analyze and render an ACL audit for the complete repository in unrestricted mode.

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

Throws:

ClientException

renderAudit

public void renderAudit(CoreSession session,
               DocumentModel doc)
                 throws ClientException

Description copied from interface: IAclExcelLayoutBuilder

Analyze and render an ACL audit for the complete document tree in unrestricted mode.

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

Throws:

ClientException

renderAudit

public void renderAudit(CoreSession session,
               DocumentModel doc,
               boolean unrestricted)
                 throws ClientException

Description copied from interface: IAclExcelLayoutBuilder

Analyze and render an ACL audit for the input document and its children.

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

Throws:

ClientException

renderAudit

public void renderAudit(CoreSession session,
               DocumentModel doc,
               boolean unrestricted,
               int timeout)
                 throws ClientException

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

Throws:

ClientException

getExcel

public IExcelBuilder getExcel()

Specified by:

getExcel in interface IAclExcelLayoutBuilder