com.tsgrp.opencontent.hbase.utilities

Class HBaseUtil

java.lang.Object

com.tsgrp.opencontent.hbase.utilities.HBaseUtil

public class HBaseUtil
extends java.lang.Object

Methods for working with HBase data and content.

Constructor Summary

Constructors

Constructor and Description
HBaseUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildPath(java.util.Stack<java.lang.String> pathStack) Given the stack of objects containing our target object, build a url path string.
static void	closeHBaseAdmin(org.apache.hadoop.hbase.client.Admin admin)
static void	closeHTable(org.apache.hadoop.hbase.client.Table table) Closes the provided Table.
static void	closeScanner(org.apache.hadoop.hbase.client.ResultScanner scanner) Close the provided ResultScanner.
static void	commitToHbaseAndExternalSearch(java.lang.String ticket, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object> properties) Commits to Hbase and external search
static java.lang.Object[]	convertBytesToArray(byte[] byteArray, java.lang.String propertyType) Converts a byte array from HBase into an Object array.
static boolean[]	convertBytesToBooleanArray(byte[] byteArray)
static java.util.Date[]	convertBytesToDateArray(byte[] byteArray)
static double[]	convertBytesToDoubleArray(byte[] byteArray)
static int[]	convertBytesToIntArray(byte[] byteArray)
static java.lang.String[]	convertBytesToStringArray(byte[] byteArray)
static java.util.Map<java.lang.String,java.lang.Object>	convertEopsToPropertyMap(EnhancedObjectProperty[] newProps) Converts the newProps into a map of properties that match the Java Type of the OpenContentObject properties map.
static byte[]	convertToByteArray(java.util.List<java.lang.Object> list, java.lang.String propertyType) Overloaded version of convertToByteArray(Object[], String) for handling lists.
static byte[]	convertToByteArray(java.lang.Object[] array, java.lang.String propertyType) Converts an array of any type into an array of bytes.
static EnhancedObjectProperty	createEOPFromHBaseCell(java.lang.String repoName, byte[] cellValue)
static java.lang.String	createRootFolder(java.lang.String ticket) Creates the root folder in the repository (ONLY CALL THIS DURING THE "LET THERE BE LIGHT" initiation of HBase 1x.
static void	deleteObjects(java.lang.String[] objectsToDelete)
static void	deletePropertiesHBase(java.lang.String objectId, java.util.List<java.lang.String> properties) Deletes passed in columns in hbase
static void	externalSearchCommit(java.lang.String ticket, java.io.InputStream contentStream, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object[]> metadataNew) Given a metadata object, index document and commit changes.
static EnhancedObjectContent	getContent(java.lang.String ticket, org.apache.hadoop.hbase.client.Result hbaseResult, java.lang.String[] fileExtensions) Given a hbaseResult from a get request, populate a new EnhancedObjectContent and return it This method assumes that the hbaseResult that is passed in got both the P and C column families
static byte[]	getContentFromResult(org.apache.hadoop.hbase.client.Result hbaseResult, java.lang.String mimeType)
static java.lang.String	getFirstLifecycleState(java.lang.String ticket, java.lang.String objectType)
static java.lang.String	getIdByPathOrId(java.lang.String ticket, java.lang.String pathOrId) This method fetches an id value based on a provided variable that can be either a path to an object or an objectId.
static java.lang.String	getPathToObject(java.lang.String ticket, java.lang.String rootId, java.lang.String targetId) Iterative dfs method to traverse the hbase rel_contains folder tree to find the path to the target object id.
static EnhancedCompleteObject	getProperties(java.lang.String ticket, org.apache.hadoop.hbase.client.Result hbaseResult) Given a hbaseResult from a get request, populate a new EnhancedCompleteObject and return it NOTE: This call does NOT deal with the 'content' column family.
static java.util.Map<java.lang.String,java.lang.Object[]>	getPropertiesMap(java.lang.String objectId)
static java.lang.String[]	getRelatedChildIds(java.lang.String parentId, java.lang.String relationName) Returns an array of ids of the children of an object
static java.lang.String	getRootFolderId(java.lang.String ticket) Gets the "root" folder's ID from external search.
static org.apache.hadoop.hbase.client.Table	getTable(java.lang.String tableName, java.lang.String[] colFamilies) looks for table with tableName, if it exists it returns it otherwise it creates it
static void	hbaseCommit(java.lang.String objectId, java.lang.String tableName, HBaseConfig config, org.apache.hadoop.hbase.client.Put put) Given a put object, open an hbase table, make the update, and close the table.
static java.util.List<EnhancedObjectProperty>	mergeProperties(java.util.List<EnhancedObjectProperty> existingProps, EnhancedObjectProperty[] propsToAdd, boolean hasBeenMajorVersioned, boolean isControlledDoc) Puts the new properties that are passed in onto the eop.
static void	removeAllRelations(java.lang.String ticket, java.lang.String objectId)
static void	removeProperties(java.lang.String ticket, java.lang.String objectId, java.util.List<java.lang.String> propsToRemove) Removes properties without updating modified date/modifier.
static void	setContent(java.lang.String ticket, java.lang.String objectId, java.io.InputStream is, java.lang.String mimeType) Sets content (native or rendition) in Hbase and external search and updates modified date
static void	setNativeContent(java.lang.String ticket, java.lang.String objectId, byte[] content, java.lang.String mimeType, org.apache.hadoop.hbase.client.Put put, java.util.Map<java.lang.String,java.lang.Object[]> metadata)
static void	setOCObjectProperties(java.lang.String objectId, OpenContentObject oco, org.apache.hadoop.hbase.client.Put put, java.util.Map<java.lang.String,java.lang.Object[]> metadata)
static void	setProperties(java.lang.String objectId, EnhancedCompleteObject object, org.apache.hadoop.hbase.client.Put put, java.util.Map<java.lang.String,java.lang.Object[]> metadata, boolean newVersion, boolean majorVersion, java.lang.String objectType) Iterates through the properties on the object, determines their type, and adds them to the HBase put request and external search metadata.
static void	transformContent(java.lang.String ticket, java.lang.String objectId, HBaseConfig config, byte[] content, java.lang.String mimeType) Given in InputStream, set the appropriate content on the hbase and external search data objects.
static void	updateHbaseProperties(java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object[]> properties) Makes a request to hbase to update the list of properties provided
static void	updateModifiedProperties(java.lang.String ticket, org.apache.hadoop.hbase.client.Put put, java.util.Map<java.lang.String,java.lang.Object[]> metadata) Handle the additional properties that refreshed in setProperties.
static void	updateProperties(java.lang.String ticket, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object[]> properties) Updated properties in external search and hbase.

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseUtil

public HBaseUtil()

Method Detail

closeHTable

public static void closeHTable(org.apache.hadoop.hbase.client.Table table)

Closes the provided Table. All exceptions thrown attempting to close the table are swallowed and logged. This method is null-safe.

Parameters:

table - The Table object to attempt to close. Can be null.

closeScanner

public static void closeScanner(org.apache.hadoop.hbase.client.ResultScanner scanner)

Close the provided ResultScanner. All exceptions thrown are swallowed and logged and the method is null-safe.

Parameters:

scanner -

closeHBaseAdmin

public static void closeHBaseAdmin(org.apache.hadoop.hbase.client.Admin admin)

convertToByteArray

public static byte[] convertToByteArray(java.lang.Object[] array,
                                        java.lang.String propertyType)

Converts an array of any type into an array of bytes.

Parameters:

Object[] - array to turn into bytes

String - propertyType

Returns:

byte[]

convertToByteArray

public static byte[] convertToByteArray(java.util.List<java.lang.Object> list,
                                        java.lang.String propertyType)

Overloaded version of convertToByteArray(Object[], String) for handling lists. It just converts to an array and passes the array into the corresponding "covert to byte array" method.

Parameters:

list -

propertyType -

Returns:

convertBytesToArray

public static java.lang.Object[] convertBytesToArray(byte[] byteArray,
                                                     java.lang.String propertyType)

Converts a byte array from HBase into an Object array.

Parameters:

byte[] - byteArray

String - propertyType

Returns:

Object[]

convertBytesToStringArray

public static java.lang.String[] convertBytesToStringArray(byte[] byteArray)

convertBytesToIntArray

public static int[] convertBytesToIntArray(byte[] byteArray)

convertBytesToDoubleArray

public static double[] convertBytesToDoubleArray(byte[] byteArray)

convertBytesToBooleanArray

public static boolean[] convertBytesToBooleanArray(byte[] byteArray)

convertBytesToDateArray

public static java.util.Date[] convertBytesToDateArray(byte[] byteArray)

hbaseCommit

public static void hbaseCommit(java.lang.String objectId,
                               java.lang.String tableName,
                               HBaseConfig config,
                               org.apache.hadoop.hbase.client.Put put)

Given a put object, open an hbase table, make the update, and close the table.

Parameters:

objectId -

config -

put -

externalSearchCommit

public static void externalSearchCommit(java.lang.String ticket,
                                        java.io.InputStream contentStream,
                                        java.lang.String objectId,
                                        java.util.Map<java.lang.String,java.lang.Object[]> metadataNew)
                                 throws java.io.UnsupportedEncodingException

Given a metadata object, index document and commit changes.

Parameters:

objectId -

name -

config -

metadata -

Throws:

java.io.UnsupportedEncodingException

getRootFolderId

public static java.lang.String getRootFolderId(java.lang.String ticket)

Gets the "root" folder's ID from external search. NOTE: This will create a folder named "/" in the repo if it doesn't already exist.

Parameters:

ticket -

Returns:

createRootFolder

public static java.lang.String createRootFolder(java.lang.String ticket)

Creates the root folder in the repository (ONLY CALL THIS DURING THE "LET THERE BE LIGHT" initiation of HBase 1x. No code should actually call this directly.

Parameters:

ticket -

Returns:

objectId of the newly created root folder

setContent

public static void setContent(java.lang.String ticket,
                              java.lang.String objectId,
                              java.io.InputStream is,
                              java.lang.String mimeType)
                       throws java.io.IOException

Sets content (native or rendition) in Hbase and external search and updates modified date

Parameters:

ticket -

object - id

is - - input stream

mimeType -

Throws:

java.io.IOException - for the conversion from InputStream to byte[]

setProperties

public static void setProperties(java.lang.String objectId,
                                 EnhancedCompleteObject object,
                                 org.apache.hadoop.hbase.client.Put put,
                                 java.util.Map<java.lang.String,java.lang.Object[]> metadata,
                                 boolean newVersion,
                                 boolean majorVersion,
                                 java.lang.String objectType)

Iterates through the properties on the object, determines their type, and adds them to the HBase put request and external search metadata. The put request and metadata objects are updated in this method, but they are NOT pushed to the repositores. The caller is responsible for calling the operations to commit the put/medatata to the repositories

Parameters:

object - the object that is being created or updated in HBase

put - HBase put request (will be updated)

metadata - map of properties used when indexing external search document (will be updated)

getContent

public static EnhancedObjectContent getContent(java.lang.String ticket,
                                               org.apache.hadoop.hbase.client.Result hbaseResult,
                                               java.lang.String[] fileExtensions)

Given a hbaseResult from a get request, populate a new EnhancedObjectContent and return it This method assumes that the hbaseResult that is passed in got both the P and C column families

Parameters:

ticket -

hbaseResult - - P and C column families must be populated

Returns:

EnhancedObjectContent populated with the content and its associated type

getContentFromResult

public static byte[] getContentFromResult(org.apache.hadoop.hbase.client.Result hbaseResult,
                                          java.lang.String mimeType)

getPropertiesMap

public static java.util.Map<java.lang.String,java.lang.Object[]> getPropertiesMap(java.lang.String objectId)

getProperties

public static EnhancedCompleteObject getProperties(java.lang.String ticket,
                                                   org.apache.hadoop.hbase.client.Result hbaseResult)

Given a hbaseResult from a get request, populate a new EnhancedCompleteObject and return it NOTE: This call does NOT deal with the 'content' column family. It ignores the "C:" column family and the mimeType column. Be smart when you call this to not have your HBase 'get' call bother to get the "C:" column family if you don't want the properties.

Parameters:

ticket -

hbaseResult -

Returns:

EnhancedCompleteObject populated ONLY with properties. NOTE: NO CONTENT WILL BE RETURNED IN THE ECO. The 'objectType' on the ECO WILL be set.

updateModifiedProperties

public static void updateModifiedProperties(java.lang.String ticket,
                                            org.apache.hadoop.hbase.client.Put put,
                                            java.util.Map<java.lang.String,java.lang.Object[]> metadata)

Handle the additional properties that refreshed in setProperties. Modified date set to current and object type is pulled from the object. Add properties to put.

Parameters:

objectType -

put -

metadata -

transformContent

public static void transformContent(java.lang.String ticket,
                                    java.lang.String objectId,
                                    HBaseConfig config,
                                    byte[] content,
                                    java.lang.String mimeType)

Given in InputStream, set the appropriate content on the hbase and external search data objects. Handle transformation/native content

Parameters:

ticket -

objectId -

config -

content -

mimeType - mimeType of the source (native) content

setNativeContent

public static void setNativeContent(java.lang.String ticket,
                                    java.lang.String objectId,
                                    byte[] content,
                                    java.lang.String mimeType,
                                    org.apache.hadoop.hbase.client.Put put,
                                    java.util.Map<java.lang.String,java.lang.Object[]> metadata)

setOCObjectProperties

public static void setOCObjectProperties(java.lang.String objectId,
                                         OpenContentObject oco,
                                         org.apache.hadoop.hbase.client.Put put,
                                         java.util.Map<java.lang.String,java.lang.Object[]> metadata)

createEOPFromHBaseCell

public static EnhancedObjectProperty createEOPFromHBaseCell(java.lang.String repoName,
                                                            byte[] cellValue)

getPathToObject

public static java.lang.String getPathToObject(java.lang.String ticket,
                                               java.lang.String rootId,
                                               java.lang.String targetId)

Iterative dfs method to traverse the hbase rel_contains folder tree to find the path to the target object id. NOTE: this will NOT include the objectName in the path that is returned for documents, only the parent path including the folder name, of the passed in objectId. ex: Will return "/Wizard/Wizard/myPSIFolder" when given the folderId of the myPSIFolder Will return "/Wizard/Wizard/myPSIFolder" when given the documentId of a document in the folder

Parameters:

ticket -

rootId - id of root folder

targetId - id of requested object

Returns:

path string to target id or null if target was not found

buildPath

public static java.lang.String buildPath(java.util.Stack<java.lang.String> pathStack)

Given the stack of objects containing our target object, build a url path string.

Parameters:

pathStack - stack generated by our dfs path finding method. Top of stack contains target and bottom contains root

rootId - id of root folder

Returns:

getIdByPathOrId

public static java.lang.String getIdByPathOrId(java.lang.String ticket,
                                               java.lang.String pathOrId)

This method fetches an id value based on a provided variable that can be either a path to an object or an objectId. If pathOrId is an objectId, it returns pathOrId, otherwise it returns the objectId of the object specified by the pathOrId

Parameters:

ticket - the OC ticket for validation

pathOrId - the path or id for which to find the objectId

Returns:

an objectId of the object specified by the pathOrId parametera

getFirstLifecycleState

public static java.lang.String getFirstLifecycleState(java.lang.String ticket,
                                                      java.lang.String objectType)

deleteObjects

public static void deleteObjects(java.lang.String[] objectsToDelete)

removeAllRelations

public static void removeAllRelations(java.lang.String ticket,
                                      java.lang.String objectId)

mergeProperties

public static java.util.List<EnhancedObjectProperty> mergeProperties(java.util.List<EnhancedObjectProperty> existingProps,
                                                                     EnhancedObjectProperty[] propsToAdd,
                                                                     boolean hasBeenMajorVersioned,
                                                                     boolean isControlledDoc)

Puts the new properties that are passed in onto the eop. If the property already exists on the eco it overwrites the property with the new property.

Parameters:

newProps - properties that are going to be updated/added to/overwritten

eops - List of properties to add/write to the eco.

hasBeenMajorVersioned - boolean that tells whether or not a document has been major versioned before

isControlledDoc - boolean that tells whether or not a document is a controlled document

removeProperties

public static void removeProperties(java.lang.String ticket,
                                    java.lang.String objectId,
                                    java.util.List<java.lang.String> propsToRemove)

Removes properties without updating modified date/modifier. Should be used for "resetting" objects (for example, during transitions between lifecycle states)

Parameters:

ticket -

objectId -

propsToRemove -

deletePropertiesHBase

public static void deletePropertiesHBase(java.lang.String objectId,
                                         java.util.List<java.lang.String> properties)

Deletes passed in columns in hbase

Parameters:

objectId -

properties -

convertEopsToPropertyMap

public static java.util.Map<java.lang.String,java.lang.Object> convertEopsToPropertyMap(EnhancedObjectProperty[] newProps)

Converts the newProps into a map of properties that match the Java Type of the OpenContentObject properties map.

Parameters:

newProps - List of eops to be put into the map

Returns:

newMap The map of properties key=eop.getName()

updateProperties

public static void updateProperties(java.lang.String ticket,
                                    java.lang.String objectId,
                                    java.util.Map<java.lang.String,java.lang.Object[]> properties)

Updated properties in external search and hbase. Will check list of "blacklisted" properties that do not impact modified date. If one of the requested properties is not on the list, modified date will be updated as well.

Parameters:

ticket -

objectId -

properties -

updateHbaseProperties

public static void updateHbaseProperties(java.lang.String objectId,
                                         java.util.Map<java.lang.String,java.lang.Object[]> properties)

Makes a request to hbase to update the list of properties provided

Parameters:

objectId -

properties -

getRelatedChildIds

public static java.lang.String[] getRelatedChildIds(java.lang.String parentId,
                                                    java.lang.String relationName)

Returns an array of ids of the children of an object

Parameters:

parentId -

relationName -

Returns:

commitToHbaseAndExternalSearch

public static void commitToHbaseAndExternalSearch(java.lang.String ticket,
                                                  java.lang.String objectId,
                                                  java.util.Map<java.lang.String,java.lang.Object> properties)

Commits to Hbase and external search

Parameters:

ticket -

objectId - object id to commit to

properties. - The properties to be update. NOTE: assumes that the properties map is repoName to value

getTable

public static org.apache.hadoop.hbase.client.Table getTable(java.lang.String tableName,
                                                            java.lang.String[] colFamilies)

looks for table with tableName, if it exists it returns it otherwise it creates it

Parameters:

tableName - - name of the table to get or create

colFamilies - - array of Strings denoting the column familes to create the table with