SpiConstants

java.lang.Object
- com.google.enterprise.connector.spi.SpiConstants

```
public class SpiConstants
extends java.lang.Object
```
Non-instantiable class that holds constants used by the SPI and documents their meanings.
All constants whose names begin with PROPNAME are reserved names for properties that may be accessed from a Document returned as a query result. The actual values of these property name constants all begin with "google:". For future compatibility, all property names beginning with "google:" are reserved.

Since:

1.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpiConstants.AclAccess` Enum for the list of possible ACL access values.
`static class`	`SpiConstants.AclInheritanceType` Enum for the list of possible inheritance types.
`static class`	`SpiConstants.AclScope` Enum for the list of possible ACL scope values.
`static class`	`SpiConstants.ActionType` Enum for action types.
`static class`	`SpiConstants.CaseSensitivityType` Enum for the possible case sensitivity rules.
`static class`	`SpiConstants.ContentEncoding` Enum for feed content encoding.
`static class`	`SpiConstants.DatabaseType` This enumeration identifies databases.
`static class`	`SpiConstants.DocumentType` Enum for the list of possible document types.
`static class`	`SpiConstants.FeedType` Enum for the list of possible feed types.
`static class`	`SpiConstants.PrincipalType` Enum for the types of Principals.
`static class`	`SpiConstants.RoleType` Deprecated. Roles are ignored by the Google Search Appliance. Support for roles should be removed from connectors, as this feature will be removed from a future release of Connector Manager.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACL_PROPNAME_PREFIX` The prefix for the ACL property names.
`static java.lang.String`	`DEFAULT_MIMETYPE` The mime type that the connector manager uses as a default, if a document does not specify.
`static java.lang.String`	`DEFAULT_USERPROFILE_COLLECTION` Name of the default user profile collection.
`static java.lang.String`	`GROUP_ROLES_PROPNAME_PREFIX` Deprecated. Roles are ignored by the Google Search Appliance. Support for roles should be removed from connectors, as this feature will be removed from a future release of Connector Manager.
`static java.util.Map<java.lang.String,java.lang.String>`	`PERSISTABLE_ATTRIBUTES` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_ACLDENYGROUPS` Identifies a multiple-valued String property that gives the list of groups that are denied access to this document.
`static java.lang.String`	`PROPNAME_ACLDENYUSERS` Identifies a multiple-valued String property that gives the list of users that are denied access to this document.
`static java.lang.String`	`PROPNAME_ACLGROUPS` Identifies a multiple-valued String property that gives the list of group ACL Scope IDs that are permitted access to this document.
`static java.lang.String`	`PROPNAME_ACLINHERITANCETYPE` Identifies a single-valued InheritanceType property.
`static java.lang.String`	`PROPNAME_ACLINHERITFROM` Identifies a single-valued String property.
`static java.lang.String`	`PROPNAME_ACLINHERITFROM_DOCID` Identifies a single-valued String property.
`static java.lang.String`	`PROPNAME_ACLINHERITFROM_FEEDTYPE` Identifies a single-valued String property.
`static java.lang.String`	`PROPNAME_ACLINHERITFROM_FRAGMENT` Identifies a single-valued String property.
`static java.lang.String`	`PROPNAME_ACLUSERS` Identifies a multiple-valued String property that gives the list of users that are permitted access to this document.
`static java.lang.String`	`PROPNAME_ACTION` Identifies an optional, single-valued property that specifies the action associated with the document.
`static java.lang.String`	`PROPNAME_AUTHMETHOD` Identifies an optional, single-valued string property that specifies the authmethod of the document.
`static java.lang.String`	`PROPNAME_CONNECTOR_INSTANCE` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_CONNECTOR_TYPE` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_CONTAINER` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_CONTENT` Identifies a single-valued property that may be either string or binary and gives direct access to the primary content to be indexed.
`static java.lang.String`	`PROPNAME_CONTENT_ENCODING` Optional, single-valued property to specify the existing encoding of the supplied content, rather than letting the Connector Manager choose an encoding to apply to the supplied content.
`static java.lang.String`	`PROPNAME_CONTENT_LENGTH` Optional, single-valued property to specify the length, in bytes, of the supplied content.
`static java.lang.String`	`PROPNAME_CONTENTURL` Deprecated. This property is unused.
`static java.lang.String`	`PROPNAME_CRAWL_IMMEDIATELY` Optional, single-valued property to specify the crawl immediately property of the record element.
`static java.lang.String`	`PROPNAME_CRAWL_ONCE` Optional, single-valued property to specify the crawl once property of the record element.
`static java.lang.String`	`PROPNAME_DISPLAYURL` Identifies an optional, single-valued property that gives a URL that should be used in a results page as the primary user reference for a document.
`static java.lang.String`	`PROPNAME_DOCID` Identifies a single-valued, string property that uniquely identifies a document to this connector.
`static java.lang.String`	`PROPNAME_DOCUMENTTYPE` Identifies a single-valued `SpiConstants.DocumentType` property that, if present, will be used to determine the object type for this document.
`static java.lang.String`	`PROPNAME_FEEDID` Deprecated. This property is unused.
`static java.lang.String`	`PROPNAME_FEEDTYPE` Identifies a single-valued FeedType property that, if present, will be used to determine the feed type for this document.
`static java.lang.String`	`PROPNAME_FOLDER` Identifies an optional, multi-valued property that specifies the folder path of the document.
`static java.lang.String`	`PROPNAME_FRAGMENT` Identifies a single-valued String property.
`static java.lang.String`	`PROPNAME_ISPUBLIC` Unless this property is present and is `false`, then the document will be marked as public.
`static java.lang.String`	`PROPNAME_LASTMODIFIED` Identifies a single-valued, date property that gives the last modified date of a document.
`static java.lang.String`	`PROPNAME_LOCK` Identifies an optional, single-valued boolean property that specifies whether the document should be locked, to prevent it from being evicted if the GSA reaches its license limit.
`static java.lang.String`	`PROPNAME_MANAGER_SHOULD_PERSIST` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_MESSAGE` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_MIMETYPE` Identifies an single-valued String property that gives the mime type for the content of this document.
`static java.lang.String`	`PROPNAME_OVERWRITEACLS` Identifies a single-valued Boolean property.
`static java.lang.String`	`PROPNAME_PAGERANK` Identifies an optional, single-valued integer property that specifies the initial PageRank of the document.
`static java.lang.String`	`PROPNAME_PERSISTED_CUSTOMDATA_1` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_PERSISTED_CUSTOMDATA_2` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_PRIMARY_FOLDER` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_SEARCHURL` Identifies an optional single-valued string property that, if present, will be used by the Search Appliance as the primary URI for this document - instead of the normal `googleconnector://` URI which the Connector Manager fabricates based on the `PROPNAME_DOCID` and the connector name.
`static java.lang.String`	`PROPNAME_SECURITYTOKEN` Deprecated. This property is unused.
`static java.lang.String`	`PROPNAME_SNAPSHOT` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_TIMESTAMP` Deprecated. The per-document store has never been publicly implemented
`static java.lang.String`	`PROPNAME_TITLE` Identifies an optional string property that is the title of the document.
`static java.lang.String`	`RESERVED_PROPNAME_PREFIX` The prefix for the reserved property names.
`static java.lang.String`	`USER_ROLES_PROPNAME_PREFIX` Deprecated. Roles are ignored by the Google Search Appliance. Support for roles should be removed from connectors, as this feature will be removed from a future release of Connector Manager.

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RESERVED_PROPNAME_PREFIX
```
public static final java.lang.String RESERVED_PROPNAME_PREFIX
```
    The prefix for the reserved property names.
    Value: "google:"
    
    Since:
    
    2.6.6
    
    See Also:
    
    Constant Field Values
  - PROPNAME_DOCID
```
public static final java.lang.String PROPNAME_DOCID
```
    Identifies a single-valued, string property that uniquely identifies a document to this connector. The internal structure of this string is opaque to the Search Appliance. Only printable, non-whitespace, ASCII characters are permitted in a DOCID.
    This property is required on all Documents. The connector implementor is encouraged to implement this by using the natural ID in the foreign repository.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    Value: google:docid
    
    See Also:
    
    Constant Field Values
  - PROPNAME_FRAGMENT
```
public static final java.lang.String PROPNAME_FRAGMENT
```
    Identifies a single-valued String property. This value is used to embellish named resources constructed from PROPNAME_DOCID, PROPNAME_FEEDTYPE, and PROPNAME_FRAGMENT.
    Value: google:fragment
    
    Since:
    
    3.2
    
    See Also:
    
    Constant Field Values
  - PROPNAME_LASTMODIFIED
```
public static final java.lang.String PROPNAME_LASTMODIFIED
```
    Identifies a single-valued, date property that gives the last modified date of a document. This property is optional but strongly recommended in order to associate a specific date to the document.
    Value: google:lastmodify
    
    See Also:
    
    Constant Field Values
  - PROPNAME_TITLE
```
public static final java.lang.String PROPNAME_TITLE
```
    Identifies an optional string property that is the title of the document. This value is useful for providing a title for documents that supply no content, or for which a title cannot be automatically extracted from the supplied content.
    Value: google:title
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONTENTURL
```
@Deprecated
public static final java.lang.String PROPNAME_CONTENTURL
```
    Deprecated. This property is unused.
    
    Not used.
    Value: google:contenturl
    
    See Also:
    
    Constant Field Values
  - PROPNAME_FEEDTYPE
```
public static final java.lang.String PROPNAME_FEEDTYPE
```
    Identifies a single-valued FeedType property that, if present, will be used to determine the feed type for this document. It is strongly recommended that this property be set to explicitly determine the feed type ('content' or 'web') for the document.
    If this property is not set, the feed type will be determined as follows:
    1. If there is no PROPNAME_SEARCHURL then the feed type will default to 'content' feed using a fabricated URL derived from the PROPNAME_DOCID.
    2. If there is a PROPNAME_SEARCHURL then the feed type will default to 'web' feed and use the PROPNAME_SEARCHURL as the document URL.
    Value: google:feedtype
    Since:
    
    2.4.2
    
    See Also:
    
    Constant Field Values
  - PROPNAME_FEEDID
```
@Deprecated
public static final java.lang.String PROPNAME_FEEDID
```
    Deprecated. This property is unused.
    
    Identifies a single-valued Feed ID property that, if present, will be used to identify the feed file that contains a fed document. All feed records in a single feed file will share a common google:feedid value.
    Not used.
    Value: google:feedid
    
    Since:
    
    2.6
    
    See Also:
    
    Constant Field Values
  - PROPNAME_SEARCHURL
```
public static final java.lang.String PROPNAME_SEARCHURL
```
    Identifies an optional single-valued string property that, if present, will be used by the Search Appliance as the primary URI for this document - instead of the normal googleconnector:// URI which the Connector Manager fabricates based on the PROPNAME_DOCID and the connector name.
    Value: google:searchurl
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONTENT
```
public static final java.lang.String PROPNAME_CONTENT
```
    Identifies a single-valued property that may be either string or binary and gives direct access to the primary content to be indexed.
    Value: google:content
    
    See Also:
    
    Constant Field Values
  - PROPNAME_SECURITYTOKEN
```
@Deprecated
public static final java.lang.String PROPNAME_SECURITYTOKEN
```
    Deprecated. This property is unused.
    
    Not used.
    Value: google:securitytoken
    
    See Also:
    
    Constant Field Values
  - PROPNAME_MIMETYPE
```
public static final java.lang.String PROPNAME_MIMETYPE
```
    Identifies an single-valued String property that gives the mime type for the content of this document. If this is not supplied, then the system will use the value of DEFAULT_MIMETYPE.
    Value: google:mimetype
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MIMETYPE
```
public static final java.lang.String DEFAULT_MIMETYPE
```
    The mime type that the connector manager uses as a default, if a document does not specify.
    Value: text/html
    
    See Also:
    
    Constant Field Values
  - PROPNAME_DISPLAYURL
```
public static final java.lang.String PROPNAME_DISPLAYURL
```
    Identifies an optional, single-valued property that gives a URL that should be used in a results page as the primary user reference for a document. This may be different from the contenturl, if present: contenturl should give direct access to the content file, whereas displayurl may point into the CMS's web front-end application.
    Value: google:displayurl
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ISPUBLIC
```
public static final java.lang.String PROPNAME_ISPUBLIC
```
    Unless this property is present and is false, then the document will be marked as public.
    Value: google:ispublic
    
    See Also:
    
    Constant Field Values
  - PROPNAME_OVERWRITEACLS
```
public static final java.lang.String PROPNAME_OVERWRITEACLS
```
    Identifies a single-valued Boolean property. When this property is false, ACLs will not be explicitly cleared if no ACL is provided. This is to allow a Connector to send the ACLs for a Document as a separate ACL Document. If this property is missing or true, the default behavior of always specifying an empty ACL if no ACL is provided is used.
    Value: google:overwriteacls
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - ACL_PROPNAME_PREFIX
```
public static final java.lang.String ACL_PROPNAME_PREFIX
```
    The prefix for the ACL property names.
    Value: "google:acl"
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLGROUPS
```
public static final java.lang.String PROPNAME_ACLGROUPS
```
    Identifies a multiple-valued String property that gives the list of group ACL Scope IDs that are permitted access to this document. If either of the PROPNAME_ACLGROUPS or PROPNAME_ACLUSERS properties are non-{*code null}, then the Search Appliance will grant or deny access to this document for a given user on the basis of whether the user's name appears as one of the Scope IDs in the PROPNAME_ACLUSERS list or one of the user's groups appears as one of the Scope IDs in the PROPNAME_ACLGROUPS list.
    ACL Scope ID is a group or user name within the scope of the Connector.
    Note: Roles are ignored by the Google Search Appliance. Support for roles should be removed from connectors, as this feature will be removed from a future release of Connector Manager. Without roles, users or groups with RoleType.PEEKER should not appear in the PROPNAME_ACLUSERS or PROPNAME_ACLGROUPS lists, since RoleType.READER access is implied.
    To specify more than just RoleType.READER access to the document, the Connector must add additional multi-value role properties to the document. These entries are of the form:
```
   Name = <GROUP_ROLES_PROPNAME_PREFIX> + <scopeId>
   Value = [RoleType[, ...]]
 
```
    where <GROUP_ROLES_PROPNAME_PREFIX> is the GROUP_ROLES_PROPNAME_PREFIX, <scopeId> is the group ACL Scope ID, and RoleType is one of the possible RoleType values. User ACL Roles are of the form:
```
   Name = <USER_ROLES_PROPNAME_PREFIX> + <scopeId>
   Value = [RoleType[, ...]]
 
```
    where the <scopeId> will be the user ACL Scope ID.
    If the PROPNAME_ISPUBLIC is missing or is true, then this property is ignored, since the document is public.
    If both the PROPNAME_ACLGROUPS and PROPNAME_ACLUSERS properties are null or empty, then the GSA will use the authorization SPI to grant or deny access to this document.
    The GSA may be configured to bypass on-board authorization, in which case these properties will be ignored, and the GSA will use the authorization SPI to grant or deny access to this document.
    Value: google:aclgroups
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLUSERS
```
public static final java.lang.String PROPNAME_ACLUSERS
```
    Identifies a multiple-valued String property that gives the list of users that are permitted access to this document. For details, see the PROPNAME_ACLGROUPS.
    Value: google:aclusers
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLDENYGROUPS
```
public static final java.lang.String PROPNAME_ACLDENYGROUPS
```
    Identifies a multiple-valued String property that gives the list of groups that are denied access to this document. For details, see the PROPNAME_ACLGROUPS.
    Value: google:acldenygroups
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLDENYUSERS
```
public static final java.lang.String PROPNAME_ACLDENYUSERS
```
    Identifies a multiple-valued String property that gives the list of users that are denied access to this document. For details, see the PROPNAME_ACLGROUPS.
    Value: google:acldenyusers
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLINHERITANCETYPE
```
public static final java.lang.String PROPNAME_ACLINHERITANCETYPE
```
    Identifies a single-valued InheritanceType property. This value is used to identify the ACL inheritance when no specific ACL principal is specified.
    Value: google:aclinheritancetype
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLINHERITFROM
```
public static final java.lang.String PROPNAME_ACLINHERITFROM
```
    Identifies a single-valued String property. This value is used to identify the document URL from which the ACL is inherited from.
    This property takes precedence over values specified by PROPNAME_ACLINHERITFROM_DOCID, PROPNAME_ACLINHERITFROM_FEEDTYPE, and PROPNAME_ACLINHERITFROM_FRAGMENT.
    Value: google:aclinheritfrom
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLINHERITFROM_DOCID
```
public static final java.lang.String PROPNAME_ACLINHERITFROM_DOCID
```
    Identifies a single-valued String property. This value is used to identify the document ID from which the ACL is inherited from.
    If the document from which the ACL is inherited from was fed using a different SpiConstants.FeedType than this document, then PROPNAME_ACLINHERITFROM_FEEDTYPE should also be specified.
    This property is ignored if PROPNAME_ACLINHERITFROM is also specified.
    Value: google:aclinheritfrom:docid
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLINHERITFROM_FEEDTYPE
```
public static final java.lang.String PROPNAME_ACLINHERITFROM_FEEDTYPE
```
    Identifies a single-valued String property. This value is used to identify the SpiConstants.FeedType of document from which the ACL is inherited from. If unspecified, the FeedType of the inheriting ACL is used.
    This property should be specified in conjunction with PROPNAME_ACLINHERITFROM_DOCID, and will be ignored if PROPNAME_ACLINHERITFROM is also specified.
    Value: google:aclinheritfrom:feedtype
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PROPNAME_ACLINHERITFROM_FRAGMENT
```
public static final java.lang.String PROPNAME_ACLINHERITFROM_FRAGMENT
```
    Identifies a single-valued String property. This value is used to embellish the ACL named resource from which the ACL is inherited from.
    PROPNAME_ACLINHERITFROM_DOCID, PROPNAME_ACLINHERITFROM_FEEDTYPE, and PROPNAME_ACLINHERITFROM_FRAGMENT are used to construct an PROPNAME_ACLINHERITFROM named resource.
    This property is ignored if PROPNAME_ACLINHERITFROM is also specified.
    Value: google:aclinheritfrom:fragment
    
    Since:
    
    3.2
    
    See Also:
    
    Constant Field Values
  - GROUP_ROLES_PROPNAME_PREFIX
```
@Deprecated
public static final java.lang.String GROUP_ROLES_PROPNAME_PREFIX
```
    Deprecated. Roles are ignored by the Google Search Appliance. Support for roles should be removed from connectors, as this feature will be removed from a future release of Connector Manager.
    Prefix added to the front of the group ACL Scope ID when creating a group roles property name. If the Connector wants to define specific roles associated with a group ACL Scope ID related to a document they should be stored in a multi-valued property named:
```
   GROUP_ROLES_PROPNAME_PREFIX + <scopeId>
 
```
    For example, given a group ACL Entry of "eng=reader,writer" the roles for "eng" would be stored in a property as follows:
```
 Name = "google:group:roles:eng"
 Value = [reader, writer]
 
```
    See Also:
    
    Constant Field Values
  - USER_ROLES_PROPNAME_PREFIX
```
@Deprecated
public static final java.lang.String USER_ROLES_PROPNAME_PREFIX
```
    Deprecated. Roles are ignored by the Google Search Appliance. Support for roles should be removed from connectors, as this feature will be removed from a future release of Connector Manager.
    Prefix added to the front of the user ACL Scope ID when creating a user roles property name. If the Connector wants to define specific roles associated with a user ACL Scope ID related to a document they should be stored in a multi-valued property named:
```
   USER_ROLES_PROPNAME_PREFIX + <scopeId>
 
```
    For example, given a user ACL Entry of "joe=reader,writer" the roles for "joe" would be stored in a property as follows:
```
 Name = "google:user:roles:joe"
 Value = [reader, writer]
 
```
    See Also:
    
    Constant Field Values
  - PROPNAME_ACTION
```
public static final java.lang.String PROPNAME_ACTION
```
    Identifies an optional, single-valued property that specifies the action associated with the document. If not specified, then the system will not specify the action and the default behavior will be observed.
    Value: google:action
    
    See Also:
    
    Constant Field Values
  - PROPNAME_FOLDER
```
public static final java.lang.String PROPNAME_FOLDER
```
    Identifies an optional, multi-valued property that specifies the folder path of the document. The document name should not be included in the path. Multiple values are permitted to support repositories that link documents to multiple parent folders.
    Examples:
```
     /ENGINEERING/techdoc/pdfs
     Enterprise:Marketing:Press Releases
     https://sp.example.com/sites/mylist
 
```
    Value: google:folder
    Since:
    
    2.6.6
    
    See Also:
    
    "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax", Constant Field Values
  - PROPNAME_LOCK
```
public static final java.lang.String PROPNAME_LOCK
```
    Identifies an optional, single-valued boolean property that specifies whether the document should be locked, to prevent it from being evicted if the GSA reaches its license limit. Default: false.
    Note: this property will not be indexed, it only controls whether the GSA will lock the document.
    Value: google:lock
    
    Since:
    
    2.6.4
    
    See Also:
    
    "Defining the XML Record for a Document", Constant Field Values
  - PROPNAME_CRAWL_IMMEDIATELY
```
public static final java.lang.String PROPNAME_CRAWL_IMMEDIATELY
```
    Optional, single-valued property to specify the crawl immediately property of the record element.
    
    Since:
    
    3.2.4
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CRAWL_ONCE
```
public static final java.lang.String PROPNAME_CRAWL_ONCE
```
    Optional, single-valued property to specify the crawl once property of the record element.
    
    Since:
    
    3.2.4
    
    See Also:
    
    Constant Field Values
  - PROPNAME_PAGERANK
```
public static final java.lang.String PROPNAME_PAGERANK
```
    Identifies an optional, single-valued integer property that specifies the initial PageRank of the document. Default: 96.
    A higher value specifies a higher PageRank. To boost the PageRank of the URL or group of URLs, increase the value to a number between 97 and 100. To lower the PageRank, decrease the value.
    Note: Content feeds only with GSA 7.2 or earlier. This property will not be indexed, it only controls the PageRank for the document.
    Value: google:pagerank
    
    Since:
    
    2.8
    
    See Also:
    
    "Defining the XML Record for a Document", Constant Field Values
  - PROPNAME_AUTHMETHOD
```
public static final java.lang.String PROPNAME_AUTHMETHOD
```
    Identifies an optional, single-valued string property that specifies the authmethod of the document. Default: httpbasic.
    AddPropertyFilter can be used to override the default value.
    
    Since:
    
    3.0.8
    
    See Also:
    
    Constant Field Values
  - PROPNAME_DOCUMENTTYPE
```
public static final java.lang.String PROPNAME_DOCUMENTTYPE
```
    Identifies a single-valued SpiConstants.DocumentType property that, if present, will be used to determine the object type for this document.
    If this property is not set, the document type will be RECORD.
    Value: google:documenttype
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values
  - PERSISTABLE_ATTRIBUTES
```
@Deprecated
public static final java.util.Map<java.lang.String,java.lang.String> PERSISTABLE_ATTRIBUTES
```
    Deprecated. The per-document store has never been publicly implemented
    A map keyed by property names, giving corresponding column names. If a property name is a key in this map, then it can be persisted by the Connector Manager in its per-document store. The associated value gives the name that a connector implementor should use to read records from the per-document store using JDBC. However, implementors are encouraged to use LocalDocumentStore methods rather than JDBC if possible.
    At present, the persistable attributes are:
  - PROPNAME_MANAGER_SHOULD_PERSIST
```
@Deprecated
public static final java.lang.String PROPNAME_MANAGER_SHOULD_PERSIST
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional single-valued, boolean property that marks this document as one the Connector Manager should persist locally in its per-document store. If not present, this is assumed to be false. If true, then the Connector Manager will persist all attributes that are keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONNECTOR_INSTANCE
```
@Deprecated
public static final java.lang.String PROPNAME_CONNECTOR_INSTANCE
```
    Deprecated. The per-document store has never been publicly implemented
    
    Reserved by the Connector Manager to indicate the connector instance that submitted this document. Should not be supplied by the connector developer, and if supplied, it will be ignored.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONNECTOR_TYPE
```
@Deprecated
public static final java.lang.String PROPNAME_CONNECTOR_TYPE
```
    Deprecated. The per-document store has never been publicly implemented
    
    Reserved by the Connector Manager to indicate type of the connector that submitted this document. Should not be supplied by the connector developer, and if supplied, it will be ignored.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_PRIMARY_FOLDER
```
@Deprecated
public static final java.lang.String PROPNAME_PRIMARY_FOLDER
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional, single-valued property that gives the name primary folder in which this document lives. If not supplied, but the PROPNAME_FOLDER property is supplied, then the first value of that multi-valued property will be used here. The primary use-case of this attribute is to be stored, so that a connector can later query to find all documents in a folder.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_TIMESTAMP
```
@Deprecated
public static final java.lang.String PROPNAME_TIMESTAMP
```
    Deprecated. The per-document store has never been publicly implemented
    
    Reserved by the Connector Manager to indicate the time at which the Connector Manager handled this document. Should not be supplied by the connector developer, and if supplied, it will be ignored.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_MESSAGE
```
@Deprecated
public static final java.lang.String PROPNAME_MESSAGE
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional, single-valued property that gives a message from the connector instance about the state of this document.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_SNAPSHOT
```
@Deprecated
public static final java.lang.String PROPNAME_SNAPSHOT
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional, single-valued property that gives a compact representation of a document's content and attributes, to enable a quick comparison with a foreign repository to see if the document has changed. For example, this attribute might contain a content hash. The primary use-case of this attribute is to be stored in the Connector Manager's per-document store. It will not be supplied when sending a document to the GSA for indexing.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONTAINER
```
@Deprecated
public static final java.lang.String PROPNAME_CONTAINER
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional, single-valued property that gives the name of the high-level container object in which the document lives. This may be an object such as a cabinet or list. The primary use-case of this attribute is to be stored, so that a connector can later query to find all documents in a container.
    This property is persistable (it is one of the keys in the PERSISTABLE_ATTRIBUTES map.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONTENT_LENGTH
```
public static final java.lang.String PROPNAME_CONTENT_LENGTH
```
    Optional, single-valued property to specify the length, in bytes, of the supplied content.
    
    Since:
    
    3.0.8
    
    See Also:
    
    Constant Field Values
  - PROPNAME_CONTENT_ENCODING
```
public static final java.lang.String PROPNAME_CONTENT_ENCODING
```
    Optional, single-valued property to specify the existing encoding of the supplied content, rather than letting the Connector Manager choose an encoding to apply to the supplied content. If a value of google:contentencoding is null, Connector Manager will encode the content. If the value is "base64binary", it denotes that the supplied content is already Base64 encoded. If the value is "base64compressed" it denotes the supplied content is already compressed then Base64 encoded.
    
    Since:
    
    3.0.8
    
    See Also:
    
    Constant Field Values
  - PROPNAME_PERSISTED_CUSTOMDATA_1
```
@Deprecated
public static final java.lang.String PROPNAME_PERSISTED_CUSTOMDATA_1
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional, single-valued property the Connector Manager will persist in its per-document store. This property will not be supplied when sending a document to the GSA for indexing.
    
    See Also:
    
    Constant Field Values
  - PROPNAME_PERSISTED_CUSTOMDATA_2
```
@Deprecated
public static final java.lang.String PROPNAME_PERSISTED_CUSTOMDATA_2
```
    Deprecated. The per-document store has never been publicly implemented
    
    Optional, single-valued property the Connector Manager will persist in its per-document store. This property will not be supplied when sending a document to the GSA for indexing.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USERPROFILE_COLLECTION
```
public static final java.lang.String DEFAULT_USERPROFILE_COLLECTION
```
    Name of the default user profile collection.
    
    Since:
    
    3.0
    
    See Also:
    
    Constant Field Values

Class SpiConstants

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_PROPNAME_PREFIX

PROPNAME_DOCID

PROPNAME_FRAGMENT

PROPNAME_LASTMODIFIED

PROPNAME_TITLE

PROPNAME_CONTENTURL

PROPNAME_FEEDTYPE

PROPNAME_FEEDID

PROPNAME_SEARCHURL

PROPNAME_CONTENT

PROPNAME_SECURITYTOKEN

PROPNAME_MIMETYPE

DEFAULT_MIMETYPE

PROPNAME_DISPLAYURL

PROPNAME_ISPUBLIC

PROPNAME_OVERWRITEACLS

ACL_PROPNAME_PREFIX

PROPNAME_ACLGROUPS

PROPNAME_ACLUSERS

PROPNAME_ACLDENYGROUPS

PROPNAME_ACLDENYUSERS

PROPNAME_ACLINHERITANCETYPE

PROPNAME_ACLINHERITFROM

PROPNAME_ACLINHERITFROM_DOCID

PROPNAME_ACLINHERITFROM_FEEDTYPE

PROPNAME_ACLINHERITFROM_FRAGMENT

GROUP_ROLES_PROPNAME_PREFIX

USER_ROLES_PROPNAME_PREFIX

PROPNAME_ACTION

PROPNAME_FOLDER

PROPNAME_LOCK

PROPNAME_CRAWL_IMMEDIATELY

PROPNAME_CRAWL_ONCE

PROPNAME_PAGERANK

PROPNAME_AUTHMETHOD

PROPNAME_DOCUMENTTYPE

PERSISTABLE_ATTRIBUTES

PROPNAME_MANAGER_SHOULD_PERSIST

PROPNAME_CONNECTOR_INSTANCE

PROPNAME_CONNECTOR_TYPE

PROPNAME_PRIMARY_FOLDER

PROPNAME_TIMESTAMP

PROPNAME_MESSAGE

PROPNAME_SNAPSHOT

PROPNAME_CONTAINER

PROPNAME_CONTENT_LENGTH

PROPNAME_CONTENT_ENCODING

PROPNAME_PERSISTED_CUSTOMDATA_1

PROPNAME_PERSISTED_CUSTOMDATA_2

DEFAULT_USERPROFILE_COLLECTION