com.google.enterprise.connector.spi

Class SocialCollectionHandler

java.lang.Object

com.google.enterprise.connector.spi.SocialCollectionHandler

public final class SocialCollectionHandler
extends java.lang.Object

SocialCollectionHandler initializes a social collection, which is a container in GSA for social documents, like user profile documents. These documents are excluded from default_collection. Specific modules interested in this data can query this collection to retrieve all the data.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
static boolean	initializeSocialCollection(java.lang.String gsaHost, int gsaPort, java.lang.String gsaAdmin, java.lang.String gsaAdminPassword, java.lang.String collectionName) Initialize user profile collection.
static boolean	validateCollectionName(java.lang.String collectionName) Validates name of collection to consist of [a-z][A-Z][0-9]-_

Methods inherited from class java.lang.Object

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

Method Detail

initializeSocialCollection

public static boolean initializeSocialCollection(java.lang.String gsaHost,
                                                 int gsaPort,
                                                 java.lang.String gsaAdmin,
                                                 java.lang.String gsaAdminPassword,
                                                 java.lang.String collectionName)

Initialize user profile collection. Every social connector should call this once to ensure GSA is ready to accept user profile data from the connector. If collectionName parameter is null or "" then default collection _google_social_userprofile_collection is used.

Parameters:

gsaHost - host address of GSA

gsaPort - port of GSA for gdata call

gsaAdmin - userId for making gdata call to GSA

gsaAdminPassword - password for making gdata call to GSA

collectionName - name of the collection where user profiles will go.

Returns:

true if social collection has been initialized successfully

validateCollectionName

public static boolean validateCollectionName(java.lang.String collectionName)

Validates name of collection to consist of [a-z][A-Z][0-9]-_

Parameters:

collectionName - name of collection

Returns:

true if valid