ShowUtils (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.core.tools.script.ShowUtils

```
public class ShowUtils
extends Object
```
A collection of static methods used to print textual representations of objects or collections of objects to a log.
The output of these methods show detailed textual information about objects, useful for diff-based testing pruposes.

Author:

Dave Long

(Published)

Field Summary

Fields
Modifier and Type Field and Description

static String INDENT
Amount to indent when displaying layered information (2 spaces: " ").

Fields
Modifier and Type	Field and Description
`static String`	`INDENT` Amount to indent when displaying layered information (2 spaces: " ").

Constructor Summary

Constructors
Constructor and Description

ShowUtils()

Constructors
Constructor and Description
`ShowUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getObjectNameAndClass(LibraryObject obj)` Return the name and class of the specified object
`static void`	`showAce(Logger logger, AccessControlEntry ace, String prefix)` Show details about an ACE.
`static void`	`showAcl(Logger logger, AccessControlList acl, String prefix)` Show details about an ACL.
`static void`	`showActionSpecification(Logger logger, ActionSpecification spec, String prefix)` Show details about a ActionSpecification.
`static void`	`showActivitySpecification(Logger logger, ActivitySpecification spec, String prefix)` Show details about a ActivitySpecification.
`static void`	`showActor(Logger logger, Actor actor, String prefix)` Show details about a Actor.
`static void`	`showApplicationToken(Logger logger, ApplicationToken token, String prefix)` Show details about an ApplicationToken.
`static void`	`showAttribute(Logger logger, Attribute attr, String prefix, boolean verbose, boolean showDates)` Show details about a Attribute.
`static void`	`showAttributeValue(Logger logger, LibrarySession session, String attrName, AttributeValue val, String prefix)` Produce a readable version of an AttributeValue
`static void`	`showAttributeValue(Logger logger, LibrarySession session, String attrName, AttributeValue val, String prefix, String[] hiddenKeys)` Produce a readable version of an AttributeValue
`static void`	`showAttributeValueTable(Logger logger, LibrarySession session, AttributeValueTable avt, String tblName, String prefix)` Show details about a AttributeValueTable.
`static void`	`showAttributeValueTable(Logger logger, LibrarySession session, AttributeValueTable avt, String tblName, String prefix, String[] omittedProps)` Show details about a AttributeValueTable.
`static void`	`showAuditCertificates(Logger logger, LibrarySession sess, AuditCertificate[] certs, String prefix, boolean verbose)` Show AuditCertificate information.
`static void`	`showAuditEventColumn(Logger logger, LibrarySession sess, AttributeValue av, String prefix, boolean verbose)` Show an AuditEvent column selected via `AuditingUtilities.listAggregateAuditEventColumnValues`.
`static void`	`showAuditEventColumns(Logger logger, LibrarySession sess, AttributeValue[] avs, String prefix, boolean verbose)` Show AuditEvent column information selected via `AuditingUtilities.listAggregateAuditEventColumnValues`.
`static void`	`showAuditEvents(Logger logger, LibrarySession sess, AuditEvent[] aes, String prefix, boolean verbose, boolean showDates, boolean stripNumbers)` Show AuditEvent information.
`static void`	`showAuditHandlerSpecification(Logger logger, LibrarySession session, AuditHandlerSpecification ahs, String prefix, boolean showDates)` Shows the AuditHandlerSpecification.
`static void`	`showAuditSpecification(Logger logger, LibrarySession session, AuditSpecification spec, String prefix, boolean showDates)` Shows the audit spec.
`static void`	`showAuditTargetSpecification(Logger logger, LibrarySession session, AuditTargetSpecification ats, String prefix)` Shows the AuditTargetSpecification.
`static void`	`showAuditTypeEntryValues(Logger logger, LibrarySession session, AuditTypeEntryValue[] atevs, String prefix)` Shows a set of AuditTypeEntryValues.
`static void`	`showAuditTypeList(Logger logger, LibrarySession session, AuditTypeList typeList, String prefix)` Shows the AuditTypeList.
`static void`	`showAutoFolderingActionSpecification(Logger logger, AutoFolderingActionSpecification spec, String prefix)` Show details about an AutoFolderingActionSpecification.
`static void`	`showBooleanObjectArray(Logger logger, LibrarySession session, Boolean[] boolValues, String prefix)` Shows an array of Boolean, one value per line
`static void`	`showCapabilities(Logger logger, PublicObject po, String prefix)` Show capabilities about an object.
`static void`	`showClassDomain(Logger logger, ClassDomain cd, String prefix)` Show details about a ClassDomain.
`static void`	`showClassObject(Logger logger, ClassObject co, String prefix, boolean verbose, boolean showDates)` Show details about a ClassObject.
`static void`	`showControllerPlan(Logger logger, ControllerPlan cplan, String prefix, boolean verbose, boolean showDates, boolean stripNums)` Show details about a ControllerPlan.
`static void`	`showControllerPlanExecution(Logger logger, ControllerPlanExecution cplanExec, String prefix, boolean verbose, boolean showDates, boolean stripNums)` Show details about a ControllerPlanExecution.
`static void`	`showControllerState(Logger logger, ControllerState cs, String prefix, boolean verbose, boolean showDates, boolean stripNums)` Show details about a ControllerState.
`static void`	`showCustomMediaDriverSpecification(Logger logger, CustomMediaDriverSpecification cmds, String prefix)` Show details about a CustomMediaDriverSpecification.
`static void`	`showDateArray(Logger logger, LibrarySession session, Date[] dateValues, String prefix)` Shows an array of Date, one value per line
`static void`	`showDefinition(Logger logger, LibraryObjectDefinition def, String prefix)` Show details about an LibraryObjectDefinition.
`static void`	`showDefinitionObject(Logger logger, DefinitionObject defobj, String prefix)` Show details about an DefinitionObject.
`static void`	`showDependentView(Logger logger, DependentView dv, String prefix)` Show details about a DependentView.
`static void`	`showDocument(Logger logger, Document doc, String prefix)` Show details about a document.
`static void`	`showDocumentContentInfo(Logger logger, Document doc, String prefix)` Show details about a document's content.
`static void`	`showDocumentWithLifecycleInfo(Logger logger, Document doc, boolean showDates, String prefix)` Show lifecycle details about a document.
`static void`	`showExpandedAuditTypeList(Logger logger, LibrarySession session, AuditTypeList typeList, String className, String prefix)` Shows the AuditTypeList, expanded to include placeholders for event types applicable to the specifeid class.
`static void`	`showExtendedPermission(Logger logger, ExtendedPermission ep, String prefix)` Show details about a ExtendedPermission.
`static void`	`showFamily(Logger logger, Family family, String prefix)` Show details about a Family.
`static void`	`showFolder(Logger logger, Folder folder, String prefix)` Show details about an Folder.
`static void`	`showFolder(Logger logger, Folder folder, String prefix, boolean showCats)` Show details about an Folder.
`static void`	`showFolderCountInfo(Logger logger, Folder folder, String prefix)` Show count information about a folder.
`static void`	`showFolderedObject(Logger logger, PublicObject po, String prefix, boolean showCats)` Show details about an Foldered object.
`static void`	`showFormat(Logger logger, Format format, String prefix)` Show details about a Format.
`static void`	`showGroup(Logger logger, DirectoryGroup group, String prefix)` Show details about a Group.
`static void`	`showHandlerState(Logger logger, HandlerState hs, String prefix, boolean verbose, boolean showDates, boolean stripNums)` Show details about a HandlerState.
`static void`	`showIntegerObjectArray(Logger logger, LibrarySession session, Integer[] intValues, String prefix)` Shows an array of Integer, one value per line
`static void`	`showLibraryObject(Logger logger, LibraryObject obj, boolean showDates, String prefix)` Show details about a LibraryObject.
`static void`	`showLibraryObjectArray(Logger logger, LibrarySession session, LibraryObject[] loValues, String prefix)` Shows an array of LibraryObject, one value per line
`static void`	`showLibrayObjectIdArray(Logger logger, LibrarySession session, Long[] idValues, String prefix)` Shows an array of Long representing LibraryObjects, one value per line
`static void`	`showLifecycleDateRuleSpecification(Logger logger, LifecycleDateRuleSpecification spec, String prefix)` Show details about an LifecycleDateRuleSpecification.
`static void`	`showLifecyclePolicy(Logger logger, LifecyclePolicy lp, String prefix)` Show details about an LifecyclePolicy.
`static void`	`showLifecyclePolicyActionSpecification(Logger logger, LifecyclePolicyActionSpecification spec, String prefix)` Show details about an LifecyclePolicyActionSpecification.
`static void`	`showLifecyclePolicyEntry(Logger logger, LifecyclePolicyEntry lpe, String prefix)` Show details about an LifecyclePolicyEntry.
`static void`	`showLink(Logger logger, Link link, String prefix)` Show details about a Link.
`static void`	`showLockEntry(Logger logger, LockEntry le, String prefix)` Show details about a LockEntry.
`static void`	`showLockEntryInfo(Logger logger, PublicObject po, String prefix)` Show LockEntry details of a PublicObject.
`static void`	`showLockingInconsistencies(Logger logger, PublicObject po, String prefix)` Show Locking inconsistency details for a PublicObject.
`static void`	`showLongObjectArray(Logger logger, LibrarySession session, Long[] longValues, String prefix)` Shows an array of Long, one value per line
`static void`	`showMedia(Logger logger, Media media, String prefix)` Show details about a Media.
`static void`	`showMessageEntry(Logger logger, MessageEntry me, String prefix, boolean verbose, boolean showDates)` Show details about a MessageEntry.
`static void`	`showMessageList(Logger logger, MessageList ml, String prefix, boolean verbose, boolean showDates)` Show details about a MessageList.
`static void`	`showNodeConfiguration(Logger logger, NodeConfiguration nc, String prefix, boolean verbose, boolean showDates)` Show details about a NodeConfiguration.
`static void`	`showNodeState(Logger logger, NodeState ns, String prefix, boolean verbose, boolean showDates, boolean stripNums)` Show details about a NodeState.
`static void`	`showOperationActionSpecification(Logger logger, OperationActionSpecification spec, String prefix)` Show details about an OperationActionSpecification.
`static void`	`showPerformedActivitySpecification(Logger logger, PerformedActivitySpecification spec, String prefix)` Show details about a PerformedActivitySpecification.
`static void`	`showPermissionBundle(Logger logger, PermissionBundle pb, String prefix)` Show details about a PermissionBundle.
`static void`	`showPolicy(Logger logger, Policy policy, String prefix)` Show details about a Policy.
`static void`	`showPolicyList(Logger logger, PolicyList policyList, String prefix)` Show details about a PolicyList.
`static void`	`showPolicyListElement(Logger logger, PolicyListElement pele, String prefix)` Show details about a PolicyListElement.
`static void`	`showPropertyBundle(Logger logger, PropertyBundle pb, String pbName, String prefix)` Show details about a PropertyBundle.
`static void`	`showPropertyBundle(Logger logger, PropertyBundle pb, String pbName, String prefix, String[] omittedProps)` Show details about a PropertyBundle.
`static void`	`showRetentionPolicy(Logger logger, RetentionPolicy rp, String prefix)` Show details about an RetentionPolicy.
`static void`	`showServerConfiguration(Logger logger, ServerConfiguration config, String prefix, boolean verbose, boolean showDates)` Show details about a ServerConfiguration.
`static void`	`showServerSpecification(Logger logger, ServerSpecification spec, String prefix)` Show details about an ServerSpecification.
`static void`	`showServerState(Logger logger, ServerState ss, String prefix, boolean verbose, boolean showDates, boolean stripNums)` Show details about a ServerState.
`static void`	`showServiceConfiguration(Logger logger, ServiceConfiguration config, String prefix, boolean verbose)` Show details about a ServiceConfiguration.
`static void`	`showSimpleProperties(Logger logger, String attrName, SimpleProperty[] props, String[] hiddenProps, String prefix)` Show nested SimpleProperty details.
`static void`	`showSimplePropertyTable(Logger logger, String namePrefix, SimplePropertyTable spt, String[] hiddenProps, String prefix)` Show nested SimplePropertyTable details.
`static void`	`showSimplePropertyTableList(Logger logger, String namePrefix, SimplePropertyTableList sptl, String[] hiddenProps, String prefix)` Show nested SimplePropertyTableList details.
`static void`	`showStorageGroup(Logger logger, StorageGroup sg, String prefix)` Show details about a StorageGroup.
`static void`	`showStringArray(Logger logger, LibrarySession session, String[] strValues, String prefix)` Shows an array of String, one value per line
`static void`	`showTrackedActivitySpecification(Logger logger, TrackedActivitySpecification spec, String prefix)` Show details about a TrackedActivitySpecification.
`static void`	`showUser(Logger logger, DirectoryUser user, String prefix)` Show details about a User.
`static void`	`showValueDefault(Logger logger, ValueDefault vd, String prefix)` Show details about a ValueDefault.
`static void`	`showValueDomain(Logger logger, ValueDomain vd, String prefix)` Show details about a ValueDomain.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- INDENT
```
public static String INDENT
```
  Amount to indent when displaying layered information (2 spaces: " ").
  
  (Published)

Constructor Detail
- ShowUtils
```
public ShowUtils()
```

Method Detail

showLibraryObject

public static void showLibraryObject(Logger logger,
                                     LibraryObject obj,
                                     boolean showDates,
                                     String prefix)
                              throws IfsException

Show details about a LibraryObject.

Expects subclasses to delegate to more specific methods for app-specific types.

Parameters:: logger - the log context; obj - the LibraryObject to show; showDates - whether to show date info; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showClassObject

public static void showClassObject(Logger logger,
                                   ClassObject co,
                                   String prefix,
                                   boolean verbose,
                                   boolean showDates)
                            throws IfsException

Show details about a ClassObject.

Parameters:: logger - the log context; co - the ClassObject to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails
(Published)

showAttribute

public static void showAttribute(Logger logger,
                                 Attribute attr,
                                 String prefix,
                                 boolean verbose,
                                 boolean showDates)
                          throws IfsException

Show details about a Attribute.

Parameters:: logger - the log context; attr - the Attribute to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails
(Published)

showValueDefault

public static void showValueDefault(Logger logger,
                                    ValueDefault vd,
                                    String prefix)
                             throws IfsException

Show details about a ValueDefault.

Parameters:: logger - the log context; vd - the ValueDefault to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showValueDomain

public static void showValueDomain(Logger logger,
                                   ValueDomain vd,
                                   String prefix)
                            throws IfsException

Show details about a ValueDomain.

Parameters:: logger - the log context; vd - the ValueDomain to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showClassDomain

public static void showClassDomain(Logger logger,
                                   ClassDomain cd,
                                   String prefix)
                            throws IfsException

Show details about a ClassDomain.

Parameters:: logger - the log context; cd - the ClassDomain to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showDependentView

public static void showDependentView(Logger logger,
                                     DependentView dv,
                                     String prefix)
                              throws IfsException

Show details about a DependentView.

Parameters:: logger - the log context; dv - the DependentView to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showGroup

public static void showGroup(Logger logger,
                             DirectoryGroup group,
                             String prefix)
                      throws IfsException

Show details about a Group.

Parameters:: logger - the log context; group - the group to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showUser

public static void showUser(Logger logger,
                            DirectoryUser user,
                            String prefix)
                     throws IfsException

Show details about a User.

Parameters:: logger - the log context; user - the user to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showAcl

public static void showAcl(Logger logger,
                           AccessControlList acl,
                           String prefix)
                    throws IfsException

Show details about an ACL.

Parameters:: logger - the log context; acl - the ACL to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showAce

public static void showAce(Logger logger,
                           AccessControlEntry ace,
                           String prefix)
                    throws IfsException

Show details about an ACE.

Parameters:: logger - the log context; ace - the ACE to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLockEntry

public static void showLockEntry(Logger logger,
                                 LockEntry le,
                                 String prefix)
                          throws IfsException

Show details about a LockEntry.

Parameters:: logger - the log context; le - the LockEntry to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showCapabilities

public static void showCapabilities(Logger logger,
                                    PublicObject po,
                                    String prefix)
                             throws IfsException

Show capabilities about an object.

Parameters:: logger - the log context; po - the PublicObject to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLockEntryInfo

public static void showLockEntryInfo(Logger logger,
                                     PublicObject po,
                                     String prefix)
                              throws IfsException

Show LockEntry details of a PublicObject.

Parameters:: logger - the log context; po - the PublicObject to show LockEntry info; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLockingInconsistencies
```
public static void showLockingInconsistencies(Logger logger,
                                              PublicObject po,
                                              String prefix)
                                       throws IfsException
```
Show Locking inconsistency details for a PublicObject.
This logs a warning if the LockObject and LockEntriy associations for a PublicObject are not consistent.

Parameters:

logger - the log context

po - the PublicObject to show Locking inconsistencies

prefix - the indentation prefix

Throws:

IfsException - if the operation fails

(Published)

showApplicationToken

public static void showApplicationToken(Logger logger,
                                        ApplicationToken token,
                                        String prefix)
                                 throws IfsException

Show details about an ApplicationToken.

Parameters:: logger - the log context; token - the ApplicationToken to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showFormat

public static void showFormat(Logger logger,
                              Format format,
                              String prefix)
                       throws IfsException

Show details about a Format.

Parameters:: logger - the log context; format - the Format to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showPermissionBundle

public static void showPermissionBundle(Logger logger,
                                        PermissionBundle pb,
                                        String prefix)
                                 throws IfsException

Show details about a PermissionBundle.

Parameters:: logger - the log context; pb - the PermissionBundle to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showExtendedPermission

public static void showExtendedPermission(Logger logger,
                                          ExtendedPermission ep,
                                          String prefix)
                                   throws IfsException

Show details about a ExtendedPermission.

Parameters:: logger - the log context; ep - the ExtendedPermission to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showPolicy

public static void showPolicy(Logger logger,
                              Policy policy,
                              String prefix)
                       throws IfsException

Show details about a Policy.

Parameters:: logger - the log context; policy - the Policy to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showPolicyList

public static void showPolicyList(Logger logger,
                                  PolicyList policyList,
                                  String prefix)
                           throws IfsException

Show details about a PolicyList.

Parameters:: logger - the log context; policyList - the PolicyList to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showPolicyListElement

public static void showPolicyListElement(Logger logger,
                                         PolicyListElement pele,
                                         String prefix)
                                  throws IfsException

Show details about a PolicyListElement.

Parameters:: logger - the log context; pele - the PolicyListElement to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showRetentionPolicy

public static void showRetentionPolicy(Logger logger,
                                       RetentionPolicy rp,
                                       String prefix)
                                throws IfsException

Show details about an RetentionPolicy.

Parameters:: logger - the log context; rp - the RetentionPolicy to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLifecyclePolicy

public static void showLifecyclePolicy(Logger logger,
                                       LifecyclePolicy lp,
                                       String prefix)
                                throws IfsException

Show details about an LifecyclePolicy.

Parameters:: logger - the log context; lp - the LifecyclePolicy to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLifecyclePolicyEntry

public static void showLifecyclePolicyEntry(Logger logger,
                                            LifecyclePolicyEntry lpe,
                                            String prefix)
                                     throws IfsException

Show details about an LifecyclePolicyEntry.

Parameters:: logger - the log context; lpe - the LifecyclePolicyEntry to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLifecycleDateRuleSpecification

public static void showLifecycleDateRuleSpecification(Logger logger,
                                                      LifecycleDateRuleSpecification spec,
                                                      String prefix)
                                               throws IfsException

Show details about an LifecycleDateRuleSpecification.

Parameters:: logger - the log context; spec - the LifecycleDateRuleSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLifecyclePolicyActionSpecification

public static void showLifecyclePolicyActionSpecification(Logger logger,
                                                          LifecyclePolicyActionSpecification spec,
                                                          String prefix)
                                                   throws IfsException

Show details about an LifecyclePolicyActionSpecification.

Parameters:: logger - the log context; spec - the LifecyclePolicyActionSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showDocumentWithLifecycleInfo

public static void showDocumentWithLifecycleInfo(Logger logger,
                                                 Document doc,
                                                 boolean showDates,
                                                 String prefix)
                                          throws IfsException

Show lifecycle details about a document.

Parameters:: logger - the log context; doc - the document to show; showDates - true if date values can be shown; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showMedia

public static void showMedia(Logger logger,
                             Media media,
                             String prefix)
                      throws IfsException

Show details about a Media.

Parameters:: logger - the log context; media - the Media to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showCustomMediaDriverSpecification

public static void showCustomMediaDriverSpecification(Logger logger,
                                                      CustomMediaDriverSpecification cmds,
                                                      String prefix)
                                               throws IfsException

Show details about a CustomMediaDriverSpecification.

Parameters:: logger - the log context; cmds - the CustomMediaDriverSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showStorageGroup

public static void showStorageGroup(Logger logger,
                                    StorageGroup sg,
                                    String prefix)
                             throws IfsException

Show details about a StorageGroup.

Parameters:: logger - the log context; sg - the StorageGroup to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showServiceConfiguration

public static void showServiceConfiguration(Logger logger,
                                            ServiceConfiguration config,
                                            String prefix,
                                            boolean verbose)
                                     throws IfsException

Show details about a ServiceConfiguration.

Parameters:: logger - the log context; config - the ServiceConfiguration to show; prefix - the indentation prefix; verbose - whether output should be verbose
Throws:: IfsException - if the operation fails
(Published)

showNodeConfiguration

public static void showNodeConfiguration(Logger logger,
                                         NodeConfiguration nc,
                                         String prefix,
                                         boolean verbose,
                                         boolean showDates)
                                  throws IfsException

Show details about a NodeConfiguration.

Parameters:: logger - the log context; nc - the NodeConfiguration to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails
(Published)

showServerConfiguration

public static void showServerConfiguration(Logger logger,
                                           ServerConfiguration config,
                                           String prefix,
                                           boolean verbose,
                                           boolean showDates)
                                    throws IfsException

Show details about a ServerConfiguration.

Parameters:: logger - the log context; config - the ServerConfiguration to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails
(Published)

showControllerState

public static void showControllerState(Logger logger,
                                       ControllerState cs,
                                       String prefix,
                                       boolean verbose,
                                       boolean showDates,
                                       boolean stripNums)
                                throws IfsException

Show details about a ControllerState.

Parameters:: logger - the log context; cs - the ControllerState to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons; stripNums - whether output should strip numerical data from Audit information
Throws:: IfsException - if the operation fails
(Published)

showControllerPlan

public static void showControllerPlan(Logger logger,
                                      ControllerPlan cplan,
                                      String prefix,
                                      boolean verbose,
                                      boolean showDates,
                                      boolean stripNums)
                               throws IfsException

Show details about a ControllerPlan.

Parameters:: logger - the log context; cplan - the ControllerPlan to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons; stripNums - whether output should strip numerical data from Audit information
Throws:: IfsException - if the operation fails
(Published)

showControllerPlanExecution

public static void showControllerPlanExecution(Logger logger,
                                               ControllerPlanExecution cplanExec,
                                               String prefix,
                                               boolean verbose,
                                               boolean showDates,
                                               boolean stripNums)
                                        throws IfsException

Show details about a ControllerPlanExecution.

Parameters:: logger - the log context; cplan - the ControllerPlanExecution to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons; stripNums - whether output should strip numerical data from Audit information
Throws:: IfsException - if the operation fails
(Published)

showNodeState
```
public static void showNodeState(Logger logger,
                                 NodeState ns,
                                 String prefix,
                                 boolean verbose,
                                 boolean showDates,
                                 boolean stripNums)
                          throws IfsException
```
Show details about a NodeState.

Parameters:

logger - the log context

ns - the NodeState to show

prefix - the indentation prefix

verbose - whether output should be verbose

showDates - whether output should contain dates or other data that is not suitable for test canons

stripNums - whether output should strip numerical data from Audit information

Throws:

IfsException - if the operation fails

(Published)

showServerState
```
public static void showServerState(Logger logger,
                                   ServerState ss,
                                   String prefix,
                                   boolean verbose,
                                   boolean showDates,
                                   boolean stripNums)
                            throws IfsException
```
Show details about a ServerState.

Parameters:

logger - the log context

ss - the ServerState to show

prefix - the indentation prefix

verbose - whether output should be verbose

showDates - whether output should contain dates or other data that is not suitable for test canons

stripNums - whether output should strip numerical data from Audit information

Throws:

IfsException - if the operation fails

(Published)

showHandlerState

public static void showHandlerState(Logger logger,
                                    HandlerState hs,
                                    String prefix,
                                    boolean verbose,
                                    boolean showDates,
                                    boolean stripNums)
                             throws IfsException

Show details about a HandlerState.

Parameters:: logger - the log context; hs - the HandlerState to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons; stripNums - whether output should strip numerical data from Audit information
Throws:: IfsException - if the operation fails
(Published)

showDefinition

public static void showDefinition(Logger logger,
                                  LibraryObjectDefinition def,
                                  String prefix)
                           throws IfsException

Show details about an LibraryObjectDefinition.

Parameters:: logger - the log context; def - the LibraryObjectDefinition to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showDefinitionObject

public static void showDefinitionObject(Logger logger,
                                        DefinitionObject defobj,
                                        String prefix)
                                 throws IfsException

Show details about an DefinitionObject.

Parameters:: logger - the log context; defobj - the DefinitionObject to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showLink

public static void showLink(Logger logger,
                            Link link,
                            String prefix)
                     throws IfsException

Show details about a Link.

Parameters:: logger - the log context; link - the link to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showFolder

public static void showFolder(Logger logger,
                              Folder folder,
                              String prefix)
                       throws IfsException

Show details about an Folder.

Parameters:: logger - the log context; folder - the folder to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showFolder

public static void showFolder(Logger logger,
                              Folder folder,
                              String prefix,
                              boolean showCats)
                       throws IfsException

Show details about an Folder.

Parameters:: logger - the log context; folder - the folder to show; prefix - the indentation prefix; showCats - whether to show the Category information
Throws:: IfsException - if the operation fails
(Published)

showFolderCountInfo

public static void showFolderCountInfo(Logger logger,
                                       Folder folder,
                                       String prefix)
                                throws IfsException

Show count information about a folder.

Parameters:: logger - the log context; folder - the folder to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showFolderedObject

public static void showFolderedObject(Logger logger,
                                      PublicObject po,
                                      String prefix,
                                      boolean showCats)
                               throws IfsException

Show details about an Foldered object.

Parameters:: logger - the log context; po - the foldered object to show; prefix - the indentation prefix; showCats - whether to show the Category information
Throws:: IfsException - if the operation fails
(Published)

showFamily

public static void showFamily(Logger logger,
                              Family family,
                              String prefix)
                       throws IfsException

Show details about a Family.

Parameters:: logger - the log context; family - the family to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showDocument

public static void showDocument(Logger logger,
                                Document doc,
                                String prefix)
                         throws IfsException

Show details about a document.

Parameters:: logger - the log context; doc - the document to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showDocumentContentInfo

public static void showDocumentContentInfo(Logger logger,
                                           Document doc,
                                           String prefix)
                                    throws IfsException

Show details about a document's content.

Parameters:: logger - the log context; doc - the document to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showAttributeValue

public static void showAttributeValue(Logger logger,
                                      LibrarySession session,
                                      String attrName,
                                      AttributeValue val,
                                      String prefix)
                               throws IfsException

Produce a readable version of an AttributeValue

Parameters:: logger - the log context; session - the session context; attrName - the AttributeValue name; val - the AttributeValue value; prefix - the indent level
Throws:: IfsException - if the operation fails
(Published)

showAttributeValue

public static void showAttributeValue(Logger logger,
                                      LibrarySession session,
                                      String attrName,
                                      AttributeValue val,
                                      String prefix,
                                      String[] hiddenKeys)
                               throws IfsException

Produce a readable version of an AttributeValue

Parameters:: logger - the log context; session - the session context; attrName - the AttributeValue name; val - the AttributeValue value; prefix - the indent level; hiddenKeys - the keys (if AV is a map) for which the values should be hidden
Throws:: IfsException - if the operation fails
(Published)

showPropertyBundle

public static void showPropertyBundle(Logger logger,
                                      PropertyBundle pb,
                                      String pbName,
                                      String prefix)
                               throws IfsException

Show details about a PropertyBundle.

Parameters:: logger - the log context; pb - the PropertyBundle to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showPropertyBundle

public static void showPropertyBundle(Logger logger,
                                      PropertyBundle pb,
                                      String pbName,
                                      String prefix,
                                      String[] omittedProps)
                               throws IfsException

Show details about a PropertyBundle.

Parameters:: logger - the log context; pb - the PropertyBundle to show; pbName - the name that identifies the PropertyBundle; prefix - the indentation prefix; omittedProps - the set of properties to not show values for
Throws:: IfsException - if the operation fails
(Published)

showSimpleProperties

public static void showSimpleProperties(Logger logger,
                                        String attrName,
                                        SimpleProperty[] props,
                                        String[] hiddenProps,
                                        String prefix)
                                 throws IfsException

Show nested SimpleProperty details.

Parameters:: logger - the log context; attrName - the Attribute name that contains the properties; props - the SimpleProperty objects to show; hiddenProps - the set of properties whose values should be hidden; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showSimplePropertyTable

public static void showSimplePropertyTable(Logger logger,
                                           String namePrefix,
                                           SimplePropertyTable spt,
                                           String[] hiddenProps,
                                           String prefix)
                                    throws IfsException

Show nested SimplePropertyTable details.

Parameters:: logger - the log context; namePrefix - prefix to use to show the name of the object; if null, do not show the name; spt - the SimplePropertyTable object to show; hiddenProps - the set of properties whose values should be hidden; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showSimplePropertyTableList

public static void showSimplePropertyTableList(Logger logger,
                                               String namePrefix,
                                               SimplePropertyTableList sptl,
                                               String[] hiddenProps,
                                               String prefix)
                                        throws IfsException

Show nested SimplePropertyTableList details.

Parameters:: logger - the log context; namePrefix - prefix to use to show the name of the object; if null, do not show the name; sptl - the SimplePropertyTableList object to show; hiddenProps - the set of properties whose values should be hidden; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showAttributeValueTable

public static void showAttributeValueTable(Logger logger,
                                           LibrarySession session,
                                           AttributeValueTable avt,
                                           String tblName,
                                           String prefix)
                                    throws IfsException

Show details about a AttributeValueTable.

Parameters:: logger - the log context; session - the session context; avt - the AttributeValueTable to show; tblName - the name of this table; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showAttributeValueTable

public static void showAttributeValueTable(Logger logger,
                                           LibrarySession session,
                                           AttributeValueTable avt,
                                           String tblName,
                                           String prefix,
                                           String[] omittedProps)
                                    throws IfsException

Show details about a AttributeValueTable.

Parameters:: logger - the log context; session - the session context; avt - the AttributeValueTable to show; tblName - the name of this table; prefix - the indentation prefix; omittedProps - the set of properties to not show values for
Throws:: IfsException - if the operation fails
(Published)

showAuditEvents

public static void showAuditEvents(Logger logger,
                                   LibrarySession sess,
                                   AuditEvent[] aes,
                                   String prefix,
                                   boolean verbose,
                                   boolean showDates,
                                   boolean stripNumbers)
                            throws IfsException

Show AuditEvent information.

Parameters:: logger - the log context; sess - the session context; aes - the AuditEvents to show; prefix - the indentation prefix; verbose - whether the output should be verbose; showDates - whether the output should show dates; stripNumbers - whether the output should strip numbers from event properties and the aux number
Throws:: IfsException - if the operation fails
(Published)

showAuditCertificates

public static void showAuditCertificates(Logger logger,
                                         LibrarySession sess,
                                         AuditCertificate[] certs,
                                         String prefix,
                                         boolean verbose)
                                  throws IfsException

Show AuditCertificate information.

Parameters:: logger - the log context; sess - the session context; certs - the AuditCertificates to show; prefix - the indentation prefix; verbose - whether the output should be verbose
Throws:: IfsException - if the operation fails
(Published)

showAuditEventColumns

public static void showAuditEventColumns(Logger logger,
                                         LibrarySession sess,
                                         AttributeValue[] avs,
                                         String prefix,
                                         boolean verbose)
                                  throws IfsException

Show AuditEvent column information selected via AuditingUtilities.listAggregateAuditEventColumnValues.

Parameters:: logger - the log context; sess - the session context; avs - the AuditEvent columns to show; prefix - the indentation prefix; verbose - whether the output should be verbose
Throws:: IfsException - if the operation fails
(Published)

showAuditEventColumn

public static void showAuditEventColumn(Logger logger,
                                        LibrarySession sess,
                                        AttributeValue av,
                                        String prefix,
                                        boolean verbose)
                                 throws IfsException

Show an AuditEvent column selected via AuditingUtilities.listAggregateAuditEventColumnValues.

Parameters:: logger - the log context; sess - the session context; av - the AuditEvent column to show; prefix - the indentation prefix; verbose - whether the output should be verbose
Throws:: IfsException - if the operation fails
(Published)

showAuditTypeEntryValues

public static void showAuditTypeEntryValues(Logger logger,
                                            LibrarySession session,
                                            AuditTypeEntryValue[] atevs,
                                            String prefix)
                                     throws IfsException

Shows a set of AuditTypeEntryValues.

Parameters:: logger - handle to the log; session - session context; atevs - the AuditTypeEntryValues to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showAuditSpecification

public static void showAuditSpecification(Logger logger,
                                          LibrarySession session,
                                          AuditSpecification spec,
                                          String prefix,
                                          boolean showDates)
                                   throws IfsException

Shows the audit spec.

Parameters:: logger - handle to the log; session - session context; spec - the AuditSpecification to show; prefix - any string prefix to be attached to output; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails
(Published)

showAuditTypeList

public static void showAuditTypeList(Logger logger,
                                     LibrarySession session,
                                     AuditTypeList typeList,
                                     String prefix)
                              throws IfsException

Shows the AuditTypeList.

Parameters:: logger - handle to the log; session - handle to session; typeList - AuditTypeList to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showExpandedAuditTypeList

public static void showExpandedAuditTypeList(Logger logger,
                                             LibrarySession session,
                                             AuditTypeList typeList,
                                             String className,
                                             String prefix)
                                      throws IfsException

Shows the AuditTypeList, expanded to include placeholders for event types applicable to the specifeid class.

Parameters:: logger - handle to the log; session - handle to session; typeList - AuditTypeList to show; className - class name to include placeholders for; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showAuditTargetSpecification

public static void showAuditTargetSpecification(Logger logger,
                                                LibrarySession session,
                                                AuditTargetSpecification ats,
                                                String prefix)
                                         throws IfsException

Shows the AuditTargetSpecification.

Parameters:: logger - handle to the log; session - handle to session; ats - AuditTargetSpecification to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showAuditHandlerSpecification

public static void showAuditHandlerSpecification(Logger logger,
                                                 LibrarySession session,
                                                 AuditHandlerSpecification ahs,
                                                 String prefix,
                                                 boolean showDates)
                                          throws IfsException

Shows the AuditHandlerSpecification.

Parameters:: logger - handle to the log; session - handle to session; ahs - AuditHandlerSpecification to show; prefix - any string prefix to be attached to output; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails
(Published)

showServerSpecification

public static void showServerSpecification(Logger logger,
                                           ServerSpecification spec,
                                           String prefix)
                                    throws IfsException

Show details about an ServerSpecification.

Parameters:: logger - the log context; spec - the ServerSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showOperationActionSpecification

public static void showOperationActionSpecification(Logger logger,
                                                    OperationActionSpecification spec,
                                                    String prefix)
                                             throws IfsException

Show details about an OperationActionSpecification.

Parameters:: logger - the log context; spec - the OperationActionSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showAutoFolderingActionSpecification

public static void showAutoFolderingActionSpecification(Logger logger,
                                                        AutoFolderingActionSpecification spec,
                                                        String prefix)
                                                 throws IfsException

Show details about an AutoFolderingActionSpecification.

Parameters:: logger - the log context; spec - the AutoFolderingActionSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails
(Published)

showMessageList

public static void showMessageList(Logger logger,
                                   MessageList ml,
                                   String prefix,
                                   boolean verbose,
                                   boolean showDates)
                            throws IfsException

Show details about a MessageList.

Parameters:: logger - the log context; ml - the MessageList to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails

showMessageEntry

public static void showMessageEntry(Logger logger,
                                    MessageEntry me,
                                    String prefix,
                                    boolean verbose,
                                    boolean showDates)
                             throws IfsException

Show details about a MessageEntry.

Parameters:: logger - the log context; me - the MessageEntry to show; prefix - the indentation prefix; verbose - whether output should be verbose; showDates - whether output should contain dates or other data that is not suitable for test canons
Throws:: IfsException - if the operation fails

showActivitySpecification

public static void showActivitySpecification(Logger logger,
                                             ActivitySpecification spec,
                                             String prefix)
                                      throws IfsException

Show details about a ActivitySpecification.

Parameters:: logger - the log context; spec - the ActivitySpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showActionSpecification

public static void showActionSpecification(Logger logger,
                                           ActionSpecification spec,
                                           String prefix)
                                    throws IfsException

Show details about a ActionSpecification.

Parameters:: logger - the log context; spec - the ActionSpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showPerformedActivitySpecification

public static void showPerformedActivitySpecification(Logger logger,
                                                      PerformedActivitySpecification spec,
                                                      String prefix)
                                               throws IfsException

Show details about a PerformedActivitySpecification.

Parameters:: logger - the log context; spec - the PerformedActivitySpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showTrackedActivitySpecification

public static void showTrackedActivitySpecification(Logger logger,
                                                    TrackedActivitySpecification spec,
                                                    String prefix)
                                             throws IfsException

Show details about a TrackedActivitySpecification.

Parameters:: logger - the log context; spec - the TrackedActivitySpecification to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

showActor

public static void showActor(Logger logger,
                             Actor actor,
                             String prefix)
                      throws IfsException

Show details about a Actor.

Parameters:: logger - the log context; actor - the Actor to show; prefix - the indentation prefix
Throws:: IfsException - if the operation fails

getObjectNameAndClass
```
public static String getObjectNameAndClass(LibraryObject obj)
                                    throws IfsException
```
Return the name and class of the specified object

Parameters:

obj - the object

Returns:

the name and class

Throws:

IfsException - if the operation fails

(Published)

showStringArray

public static void showStringArray(Logger logger,
                                   LibrarySession session,
                                   String[] strValues,
                                   String prefix)
                            throws IfsException

Shows an array of String, one value per line

Parameters:: logger - handle to the log; session - handle to session; strValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showLongObjectArray

public static void showLongObjectArray(Logger logger,
                                       LibrarySession session,
                                       Long[] longValues,
                                       String prefix)
                                throws IfsException

Shows an array of Long, one value per line

Parameters:: logger - handle to the log; session - handle to session; longValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showIntegerObjectArray

public static void showIntegerObjectArray(Logger logger,
                                          LibrarySession session,
                                          Integer[] intValues,
                                          String prefix)
                                   throws IfsException

Shows an array of Integer, one value per line

Parameters:: logger - handle to the log; session - handle to session; intValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showBooleanObjectArray

public static void showBooleanObjectArray(Logger logger,
                                          LibrarySession session,
                                          Boolean[] boolValues,
                                          String prefix)
                                   throws IfsException

Shows an array of Boolean, one value per line

Parameters:: logger - handle to the log; session - handle to session; boolValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showDateArray

public static void showDateArray(Logger logger,
                                 LibrarySession session,
                                 Date[] dateValues,
                                 String prefix)
                          throws IfsException

Shows an array of Date, one value per line

Parameters:: logger - handle to the log; session - handle to session; dateValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showLibraryObjectArray

public static void showLibraryObjectArray(Logger logger,
                                          LibrarySession session,
                                          LibraryObject[] loValues,
                                          String prefix)
                                   throws IfsException

Shows an array of LibraryObject, one value per line

Parameters:: logger - handle to the log; session - handle to session; loValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

showLibrayObjectIdArray

public static void showLibrayObjectIdArray(Logger logger,
                                           LibrarySession session,
                                           Long[] idValues,
                                           String prefix)
                                    throws IfsException

Shows an array of Long representing LibraryObjects, one value per line

Parameters:: logger - handle to the log; session - handle to session; idValues - values to show; prefix - any string prefix to be attached to output
Throws:: IfsException - if the operation fails
(Published)

Class ShowUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDENT

Constructor Detail

ShowUtils

Method Detail

showLibraryObject

showClassObject

showAttribute

showValueDefault

showValueDomain

showClassDomain

showDependentView

showGroup

showUser

showAcl

showAce

showLockEntry

showCapabilities

showLockEntryInfo

showLockingInconsistencies

showApplicationToken

showFormat

showPermissionBundle

showExtendedPermission

showPolicy

showPolicyList

showPolicyListElement

showRetentionPolicy

showLifecyclePolicy

showLifecyclePolicyEntry

showLifecycleDateRuleSpecification

showLifecyclePolicyActionSpecification

showDocumentWithLifecycleInfo

showMedia

showCustomMediaDriverSpecification

showStorageGroup

showServiceConfiguration

showNodeConfiguration

showServerConfiguration

showControllerState

showControllerPlan

showControllerPlanExecution

showNodeState

showServerState

showHandlerState

showDefinition

showDefinitionObject

showLink

showFolder

showFolder

showFolderCountInfo

showFolderedObject

showFamily

showDocument

showDocumentContentInfo

showAttributeValue

showAttributeValue

showPropertyBundle

showPropertyBundle

showSimpleProperties

showSimplePropertyTable

showSimplePropertyTableList

showAttributeValueTable

showAttributeValueTable

showAuditEvents

showAuditCertificates

showAuditEventColumns

showAuditEventColumn

showAuditTypeEntryValues

showAuditSpecification

showAuditTypeList

showExpandedAuditTypeList

showAuditTargetSpecification

showAuditHandlerSpecification

showServerSpecification