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
protected org.apache.poi.ss.usermodel.CellStyle	aclHeaderStyle
protected static int	CELL_WIDTH_UNIT
protected IDataProcessor	data
protected IExcelBuilder	excel
protected IContentFilter	filter
protected org.apache.poi.ss.usermodel.CellStyle	grayTextStyle
protected ReportLayout	layout
protected ReportLayoutSettings	layoutSettings
protected String	legendLockInheritance
protected String	legendPermissionDenied
protected int	legendSheetId
protected String	legendSheetName
protected org.apache.poi.ss.usermodel.CellStyle	lockInheritanceStyle
protected static org.apache.commons.logging.Log	log
protected int	mainSheetId
protected String	mainSheetName
protected static String	PROPERTY_LEGEND_LOCK_INHERITANCE
protected static String	PROPERTY_LEGEND_PERM_DENIED
protected static String	PROPERTY_LEGEND_SHEET_NAME
protected static String	PROPERTY_MAIN_SHEET_NAME
protected AclNameShortner	shortner
static int	STATUS_COL
static int	STATUS_ROW
protected int	treeLineCursor
protected org.apache.poi.ss.usermodel.CellStyle	userHeaderStyle

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	analyzeAndRender(CoreSession session, DocumentModel doc, int timeout)
protected void	configure(CoreSession session)
static ReportLayoutSettings	defaultLayout()
protected String	formatAce(Pair<String,Boolean> ace)
protected String	formatAcl(Collection<Pair<String,Boolean>> acls) Renders all ACE separated by a , Each ACE name is formated using formatAce(Pair ace)
protected void	formatFileTreeCellLayout(int maxDepth, int minDepth, int colStart) Set column of size of each file tree column, and apply a freeze pan to fix the tree columns and header rows.
protected String	formatPermission(String permission)
IExcelBuilder	getExcel()
protected void	render(IDataProcessor data)
protected void	renderAcl(com.google.common.collect.Multimap<String,Pair<String,Boolean>> userAcls) Render a row with all ACL of a given input file.
protected void	renderAcl(com.google.common.collect.Multimap<String,Pair<String,Boolean>> userAcls, org.apache.poi.ss.usermodel.CellStyle style)
protected void	renderAcl(com.google.common.collect.Multimap<String,Pair<String,Boolean>> localAcls, com.google.common.collect.Multimap<String,Pair<String,Boolean>> inheritedAcls) Render local AND inherited ACL.
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)
protected void	renderFilename(String title, int depth, boolean lockInheritance)
protected void	renderFileTreeAndAclMatrix(Collection<DocumentSummary> analyses, int minDepth, int maxDepth)
protected void	renderFinal() Perform various general tasks, such as setting the current sheet zoom.
protected void	renderHeader(int tableStartColumn, Set<String> userOrGroups, Set<String> permission) Write users and groups on the first row.
protected void	renderHeaderUsers(int tableStartColumn, Set<String> userOrGroups)
protected void	renderInit() Initialize layout data model and pre-built cell styles
protected void	renderLegend(DataProcessor.ProcessorStatus status, String message)
protected int	renderLegendAcl(int row, int col)
protected int	renderLegendErrorMessage(int row, int col, DataProcessor.ProcessorStatus status, String message)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

PROPERTY_MAIN_SHEET_NAME

protected static final String PROPERTY_MAIN_SHEET_NAME

See Also:

Constant Field Values

PROPERTY_LEGEND_SHEET_NAME

protected static final String PROPERTY_LEGEND_SHEET_NAME

See Also:

Constant Field Values

PROPERTY_LEGEND_LOCK_INHERITANCE

protected static final String PROPERTY_LEGEND_LOCK_INHERITANCE

See Also:

Constant Field Values

PROPERTY_LEGEND_PERM_DENIED

protected static final String PROPERTY_LEGEND_PERM_DENIED

See Also:

Constant Field Values

excel

protected IExcelBuilder excel

CELL_WIDTH_UNIT

protected static int CELL_WIDTH_UNIT

STATUS_ROW

public static int STATUS_ROW

STATUS_COL

public static int STATUS_COL

layoutSettings

protected ReportLayoutSettings layoutSettings

layout

protected ReportLayout layout

treeLineCursor

protected int treeLineCursor

userHeaderStyle

protected org.apache.poi.ss.usermodel.CellStyle userHeaderStyle

aclHeaderStyle

protected org.apache.poi.ss.usermodel.CellStyle aclHeaderStyle

lockInheritanceStyle

protected org.apache.poi.ss.usermodel.CellStyle lockInheritanceStyle

grayTextStyle

protected org.apache.poi.ss.usermodel.CellStyle grayTextStyle

mainSheetId

protected int mainSheetId

legendSheetId

protected int legendSheetId

mainSheetName

protected String mainSheetName

legendSheetName

protected String legendSheetName

legendLockInheritance

protected String legendLockInheritance

legendPermissionDenied

protected String legendPermissionDenied

filter

protected IContentFilter filter

shortner

protected AclNameShortner shortner

data

protected IDataProcessor data

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)

Description copied from interface: IAclExcelLayoutBuilder

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

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

renderAudit

public void renderAudit(CoreSession session,
                        DocumentModel doc)

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

renderAudit

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

Description copied from interface: IAclExcelLayoutBuilder

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

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

renderAudit

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

Specified by:

renderAudit in interface IAclExcelLayoutBuilder

analyzeAndRender

protected void analyzeAndRender(CoreSession session,
                                DocumentModel doc,
                                int timeout)

configure

protected void configure(CoreSession session)

render

protected void render(IDataProcessor data)

renderInit

protected void renderInit()

Initialize layout data model and pre-built cell styles

renderFinal

protected void renderFinal()

Perform various general tasks, such as setting the current sheet zoom.

renderHeader

protected void renderHeader(int tableStartColumn,
                            Set<String> userOrGroups,
                            Set<String> permission)

Write users and groups on the first row. Memorize the user (or group) column which can later be retrieved with getColumn(user)

renderHeaderUsers

protected void renderHeaderUsers(int tableStartColumn,
                                 Set<String> userOrGroups)

renderFileTreeAndAclMatrix

protected void renderFileTreeAndAclMatrix(Collection<DocumentSummary> analyses,
                                          int minDepth,
                                          int maxDepth)

renderFilename

protected void renderFilename(String title,
                              int depth,
                              boolean lockInheritance)

renderAcl

protected void renderAcl(com.google.common.collect.Multimap<String,Pair<String,Boolean>> userAcls)

Render a row with all ACL of a given input file.

renderAcl

protected void renderAcl(com.google.common.collect.Multimap<String,Pair<String,Boolean>> userAcls,
                         org.apache.poi.ss.usermodel.CellStyle style)

renderAcl

protected void renderAcl(com.google.common.collect.Multimap<String,Pair<String,Boolean>> localAcls,
                         com.google.common.collect.Multimap<String,Pair<String,Boolean>> inheritedAcls)

Render local AND inherited ACL.

• Local acl only are rendered with default font.
• Inherited acl only are rendered with gray font.
• Mixed acl (local and inherited) are rendered with default font.

renderLegend

protected void renderLegend(DataProcessor.ProcessorStatus status,
                            String message)

renderLegendErrorMessage

protected int renderLegendErrorMessage(int row,
                                       int col,
                                       DataProcessor.ProcessorStatus status,
                                       String message)

renderLegendAcl

protected int renderLegendAcl(int row,
                              int col)

formatAcl

protected String formatAcl(Collection<Pair<String,Boolean>> acls)

Renders all ACE separated by a , Each ACE name is formated using formatAce(Pair ace)

Returns:

formatAce

protected String formatAce(Pair<String,Boolean> ace)

formatPermission

protected String formatPermission(String permission)

formatFileTreeCellLayout

protected void formatFileTreeCellLayout(int maxDepth,
                                        int minDepth,
                                        int colStart)

Set column of size of each file tree column, and apply a freeze pan to fix the tree columns and header rows.

getExcel

public IExcelBuilder getExcel()

Specified by:

getExcel in interface IAclExcelLayoutBuilder