SulisPublishFilter

Object
- SulisPublishFilter

```
public class SulisPublishFilter
extends Object
```
Purpose:
SulisPublishFilter provides filter-methods for publishing events, that matches and control the publishing *before* the Persistable is sent to any publishing queue.
To use the class and its methods for the purpose of filtering
the wvs.properties needs to have an entry like:

Property default="ext.sulis.worker.SulisPublishFilter/isFiltered" name="publish.service.filterpublishmethod"

and within the wt.properties the different exclusions can be configured
by using following properties (each option to be filtered is separated by a commas):

wt.publish.filterpublishmethod.isFilteredDocType=doctype1,doctype2,doctype3
wt.publish.filterpublishmethod.isFilteredName=name1,name2,name3
wt.publish.filterpublishmethod.isFilteredExtension=ext1,ext2,ext3
wt.publish.filterpublishmethod.isFilteredUserName=usr1,usr2,usr3
wt.publish.filterpublishmethod.isFilteredCustomMethod=FULL.CLASS.NAME:MethodName
wt.publish.filterpublishmethod.isFilteredAuthApp=AUTHAPP1,AUTHAPP2

Not all of those properties must have values, but those filterpublishmethod's that are needed.
Boolean Method isFiltered returns Boolean.TRUE if Document is allowed to be published, else it returns Boolean.FALSE .
The Method isFiltered uses Windchill's API for publishing filter. NOTE: The customized Method defined in the property setting gets Map and is able to modify and return this map to the SulisPublishFilter in order to customize any result. The MAP for the customized method has following entries: SulisPublishFilter.KEY_OBJECT, Persistable //Key for Persistable, Persistable processing SulisPublishFilter.KEY_EXT, boolean //Key for EXTENSION, true/false (false=default , true if SulisPublishFilter would filter until now for that criteria) SulisPublishFilter.KEY_TYPE, boolean //Key for TYPE, true/false (false=default , true if SulisPublishFilter would filter until now for that criteria) SulisPublishFilter.KEY_NAME, boolean // Key for NAME, true/false (false=default , true if SulisPublishFilter would filter until now for that criteria) SulisPublishFilter.KEY_USER, boolean // Key for USER, true/false (false=default , true if SulisPublishFilter would filter until now for that criteria) SulisPublishFilter.KEY_AUTHAPP, boolean // Key for AUTHAPP, true/false (false=default , true if SulisPublishFilter would filter until now for that criteria) NOTE 2: In order to get more information about the internal decisions the SulisPublishFilter does the logger.debug or logger.trace has to be enabled for this class!
Be aware that the performance by this logger-setting may decrease and also the method-server log4j-file output is significantly increased.

Version:

1.8

Author:

pbruenner

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AUTHAPP`
`static String`	`KEY_CUSTOM`
`static String`	`KEY_EXT`
`static String`	`KEY_NAME`
`static String`	`KEY_OBJECT`
`static String`	`KEY_TYPE`
`static String`	`KEY_USER`
`static int`	`MAJOR` MAJOR version of the SulisPublishFilter as integer
`static int`	`MINOR` MINOR version of the SulisPublishFilter as integer

Constructor Summary

Constructors
Constructor and Description

SulisPublishFilter()

Constructors
Constructor and Description
`SulisPublishFilter()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Boolean`	`isAuthoringApplicationOK(EPMDocument epm)` PUBLIC publish filter method for EPMDocument's Authoring Application to be filtered out from publishing EPMDocuments Authoring Application's are defined via : wt.property setting: e.g.
`static boolean`	`isDocTypeOK(Persistable per)` prohibits the publishing of certain EPMDocuments and WTDocuments. The HashSet DOCTYPE_EXCLUSION defines the Document TYPES (WT/EPMDocument.getDocType) that are prohibited from publishing. The Document types are determined by getDocType() (e.g.
`static boolean`	`isExtensionOK(Persistable per)` prevent certain EPMDocuments and WTDocuments to be published. The HashSet EXTENSION_EXCLUSION defines the extensions of the documents to be filtered out from publishing.
`static Boolean`	`isFiltered(Persistable per, Boolean isFiltered)` The method isFiltered decides if a EPM/WT Document is excluded from publishing by the other methods. This method returns a Boolean.TRUE if the publishing is allowed and Boolean.FALSE if the publishing is determined to be prohibited. This method is called before the publishing process takes part by the wvs.property entry publish.service.filterpublishmethod=ext.sulis.worker.SulisPublishFilter/isFiltered The different exclusion Strings can be defined in the wvs.properties by setting the specific values separated by commas (case insensitive) wt.publish.filterpublishmethod.isFilteredDocType=doctype1,doctype2,doctype3 wt.publish.filterpublishmethod.isFilteredName=name1,name2,name3 wt.publish.filterpublishmethod.isFilteredExtension=ext1,ext2,ext3 wt.publish.filterpublishmethod.isFilteredUserName=usr1,usr2,usr3 wt.publish-filterpublishmethod.isFilteredCustomMethod=FQN_Class:Method The methods checking weather a type or extension or document name or publishing-job-user or a customized method decides, if a publishing job is filtered out from publishing or not.
`static boolean`	`isNameOK(Persistable per)` prohibits the publishing of certain EPMDocuments and WTDocuments. The HashSet DOCNAME_EXCLUSION defines the Document NAMES (determined by WT/EPMDocument.getName) that are prohibited from publishing.
`static boolean`	`isUserOK()` overloades isUserOK(per)
`static boolean`	`isUserOK(Persistable per)` prohibits the publishing of certain EPMDocuments and WTDocuments. The HashSet USERNAME_EXCLUSION defines the USERS that are prohibited from sending publish jobs.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAJOR
```
public static final int MAJOR
```
    MAJOR version of the SulisPublishFilter as integer
    
    See Also:
    Constant Field Values
  - MINOR
```
public static final int MINOR
```
    MINOR version of the SulisPublishFilter as integer
    
    See Also:
    Constant Field Values
  - KEY_EXT
```
public static final String KEY_EXT
```
    See Also:
    Constant Field Values
  - KEY_TYPE
```
public static final String KEY_TYPE
```
    See Also:
    Constant Field Values
  - KEY_NAME
```
public static final String KEY_NAME
```
    See Also:
    Constant Field Values
  - KEY_USER
```
public static final String KEY_USER
```
    See Also:
    Constant Field Values
  - KEY_OBJECT
```
public static final String KEY_OBJECT
```
    See Also:
    Constant Field Values
  - KEY_AUTHAPP
```
public static final String KEY_AUTHAPP
```
    See Also:
    Constant Field Values
  - KEY_CUSTOM
```
public static final String KEY_CUSTOM
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SulisPublishFilter
```
public SulisPublishFilter()
```
- Method Detail
  - isFiltered
```
public static Boolean isFiltered(Persistable per,
                 Boolean isFiltered)
                          throws RuntimeException,
                                 Exception
```
    The method isFiltered decides if a EPM/WT Document is excluded from publishing by the other methods.
    This method returns a Boolean.TRUE if the publishing is allowed and Boolean.FALSE if the publishing is determined to be prohibited.
    This method is called before the publishing process takes part by the wvs.property entry
    
    publish.service.filterpublishmethod=ext.sulis.worker.SulisPublishFilter/isFiltered
    
    The different exclusion Strings can be defined in the wvs.properties by setting the specific values separated by commas (case insensitive)
    
    wt.publish.filterpublishmethod.isFilteredDocType=doctype1,doctype2,doctype3
    wt.publish.filterpublishmethod.isFilteredName=name1,name2,name3
    wt.publish.filterpublishmethod.isFilteredExtension=ext1,ext2,ext3
    wt.publish.filterpublishmethod.isFilteredUserName=usr1,usr2,usr3
    wt.publish-filterpublishmethod.isFilteredCustomMethod=FQN_Class:Method
    The methods checking weather a type or extension or document name or publishing-job-user or a customized method decides, if a publishing job is filtered out from publishing or not.
    SulisPublishFilter.is[*METHOD*]OK methods provide those functionalities.
    and return each a boolean FALSE if the document to be published do match the wvs.properties entries rules and therefore may NOT be published.
    
    NOTE: The customized method may overwrite all other defined checks by modifying the related key of the passed map. The customized method that is called MUST HAVE the signature: Map (Map) The map that is passed to the method via SulisReflectionMagic consists of the keys of all other filter-methods and thus it they can be modified.
    
    Returns:
    Returns Boolean.FALSE: if Document should be prohibited from publishing.
    Boolean.TRUE: if Document is allowed to be published.
    
    Throws:
    
    Exception
    
    RuntimeException
  - isAuthoringApplicationOK
```
public static Boolean isAuthoringApplicationOK(EPMDocument epm)
```
    PUBLIC publish filter method for EPMDocument's Authoring Application
    to be filtered out from publishing EPMDocuments Authoring Application's are defined via :
    wt.property setting:
    e.g.
    wt.publish.filterpublishmethod.isFilteredAuthApp = NX,INVENTOR,AUTOCAD
    
    THIS filter mechanism is activated by this property setting:
    * STRING VALUES ENUMERATIONS EXAMPLE:
    PROE
    CADDS5
    CATIA
    OTHER
    PRODESKTOP
    MENTORB
    ACAD
    HELIX
    CCD
    UG
    IDEAS
    CADENCE
    MENTORE
    SOLIDWORKS
    SOLIDDESIGNER
    ME10
    CATIAV5
    INVENTOR
    MENTORD
    PADS
    PROTEL
    ORCAD
    ZUKENCR5
    CADSTAR
    VISULA
    PCAD
    ARBORTEXT
    CADENCE_SCH
    WINDCHILL
    MENTORB_SCH
    MENTORE_SCH
    PADS_SCH
    ORCAD_SCH
    ZUKENCR5_SCH
    CADSTAR_SCH
    VISULA_SCH
    PCAD_SCH
    PROTEL_SCH
    RSD
    MATHCAD
    ISODRAW
    COCRMOD
    COCRDRAFT
    GRAPHICSEDITOR
    CADENCE_ADW_DM
    SEDGE
    CADENCE_APD
    MSTATION
    GENERIC_ECAD
    GALAXY
    ZUKENCR5GW_SCH
    MEDUSA
    STHENO
    BLUEPRINTPCB
    CAM350
    CATIAV6
    ECADNEUTRAL
    
    Parameters:
    epm -
    
    Returns:
    Boolean.TRUE/FALSE
  - isExtensionOK
```
public static boolean isExtensionOK(Persistable per)
                             throws WTException,
                                    PropertyVetoException
```
    prevent certain EPMDocuments and WTDocuments to be published.
    The HashSet EXTENSION_EXCLUSION defines the extensions of the documents to be filtered out from publishing.
    
    Returns:
    false :if entry in wvs.properties (wt.publish.filterpublishmethod.isFilteredExtension=ext1,ext2,ext3) fits the document
    true : if wvs.properties entry does NOT disallow it.
    
    Throws:
    
    WTException
    
    PropertyVetoException
  - isNameOK
```
public static boolean isNameOK(Persistable per)
                        throws WTException,
                               PropertyVetoException
```
    prohibits the publishing of certain EPMDocuments and WTDocuments.
    The HashSet DOCNAME_EXCLUSION defines the Document NAMES (determined by WT/EPMDocument.getName) that are prohibited from publishing.
    
    Returns:
    false :if entry in wvs.properties (wt.publish.filterpublishmethod.isNameOK=ext1,ext2,ext3) fits the document
    true : if wvs.properties entry does NOT disallow it.
    
    Throws:
    
    WTException
    
    PropertyVetoException
  - isDocTypeOK
```
public static boolean isDocTypeOK(Persistable per)
                           throws WTException,
                                  PropertyVetoException
```
    prohibits the publishing of certain EPMDocuments and WTDocuments.
    The HashSet DOCTYPE_EXCLUSION defines the Document TYPES (WT/EPMDocument.getDocType) that are prohibited from publishing.
    The Document types are determined by getDocType() (e.g. NOTE, CADCOMPONENT...)
    Note: getDocType itself returns e.g. $$DOCUMENT for a WTDocument. The '$$' signs (if present) will be removed by this method.
    
    Returns:
    false :if entry in wvs.properties (wt.publish.filterpublishmethod.isFilteredDocType=ext1,ext2,ext3) fits the document
    true : if wvs.properties entry does not disallow it.
    
    Throws:
    
    WTException
    
    PropertyVetoException
  - isUserOK
```
public static boolean isUserOK()
```
    overloades isUserOK(per)
    
    Returns:
    isUserOK(per)
    
    Throws:
    
    Exception
  - isUserOK
```
public static boolean isUserOK(Persistable per)
                        throws Exception
```
    prohibits the publishing of certain EPMDocuments and WTDocuments.
    The HashSet USERNAME_EXCLUSION defines the USERS that are prohibited from sending publish jobs.
    
    Returns:
    false :if entry in wvs.properties (wt.publish.filterpublishmethod.isFilteredUserName=usr1,usr2,usr3) fits the document's publish initiator
    true : if wvs.properties entry does NOT disallow it.
    
    Throws:
    
    Exception

Class SulisPublishFilter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

MAJOR

MINOR

KEY_EXT

KEY_TYPE

KEY_NAME

KEY_USER

KEY_OBJECT

KEY_AUTHAPP

KEY_CUSTOM

Constructor Detail

SulisPublishFilter

Method Detail

isFiltered

isAuthoringApplicationOK

isExtensionOK

isNameOK

isDocTypeOK

isUserOK

isUserOK