com.oracle.communications.brm.cc.common

Class BRMUtility

java.lang.Object

com.oracle.communications.brm.cc.common.BRMUtility

public class BRMUtility
extends Object

Constructor Summary

Constructors

Constructor and Description
BRMUtility()

Method Summary

Modifier and Type	Method and Description
static ParamInfo	buildErrorParameters(FList errFlist, ParamInfo errorParamterInfo) Builds ParamInfo object recursively for each error field instance in the FList
static void	closeConnectionWithoutTimeOut(PortalContext ctx) close the connection
static PortalContext	getConnection()
static PortalContext	getConnectionWithoutTimeOut() Creates and returns single connection createConnections(int size) and getNewConnection(String name) uses this method to create a connection.
static Path	getFilePath(String filePath) Converts a path string to a Path object.
static Path	getFilePath(URI uri) Converts the given URI to a Path object.
static String	getInfranetFilePath() Get Infranet.properties file path.
static String	getPropertyValue(String propertyKey) Get property value for the given key.
static boolean	getRecordFailureFlag() Retrieves record failure flag configured in the Configurations.xml file.
static String	getStringWithParameterValues(String message, Object... params) Returns the string modified with parameters values
static int	getTimeOutConfiguration() Returns the timeOut value configured in the Configurations.xml file if timeOut is configured return its value otherwise return -1
static String	getTypeFromRestId(ResourceRef ref) Convenience method to extract the BRM Poid "type" from the given ResourceRef's id field.
static String	getTypeFromRestId(String restId) Convenience method to extract the BRM Poid "type" from the given REST ID.
static String	getUserHome() Returns user.home of system property.
static Boolean	isPoid(String id) check if given id is BRM Poid or not
static boolean	isValidURL(String URL) Check the given URL is valid or not.
static Poid	poidFromRestId(ResourceRef ref)
static Poid	poidFromRestId(String restId) Given a restID, create and return the corresponding Poid
static void	populateError(ErrorConstants error, Response.Status status) Populate the error passed with status code.
static void	releaseBadConnection(PortalContext ctx)
static void	releaseConnection(PortalContext ctx)
static String	restIdFromPoid(Poid poid) Given a Poid, returns a format that can be passed via web services.

Methods inherited from class java.lang.Object

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

Constructor Detail

BRMUtility

public BRMUtility()

Method Detail

restIdFromPoid

public static String restIdFromPoid(Poid poid)

Given a Poid, returns a format that can be passed via web services. Logic replaces all slashes in the storable class with dashes followed by a URL encoding of the resulting string

Parameters:

poid - The Poid to convert

Returns:

a string in the format db_id+type+obj_id (0.0.0.1+-account+123456) ignore the revision of the poid

poidFromRestId

public static Poid poidFromRestId(String restId)

Given a restID, create and return the corresponding Poid

Parameters:

restId - In the form 0.0.0.1+-account+123456

Returns:

The corresponding Poid

poidFromRestId

public static Poid poidFromRestId(ResourceRef ref)

getTypeFromRestId

public static String getTypeFromRestId(ResourceRef ref)

Convenience method to extract the BRM Poid "type" from the given ResourceRef's id field.

Parameters:

ref - Type of this REST ID will be returned

Returns:

type of the given REST ID

getTypeFromRestId

public static String getTypeFromRestId(String restId)

Convenience method to extract the BRM Poid "type" from the given REST ID.

Parameters:

restId - Type of this REST ID will be returned

Returns:

type of the given REST ID

getConnection

public static PortalContext getConnection()
                                   throws DeterminateException

Throws:

DeterminateException

releaseConnection

public static void releaseConnection(PortalContext ctx)

releaseBadConnection

public static void releaseBadConnection(PortalContext ctx)

buildErrorParameters

public static ParamInfo buildErrorParameters(FList errFlist,
                                             ParamInfo errorParamterInfo)
                                      throws EBufException

Builds ParamInfo object recursively for each error field instance in the FList

Parameters:

errFlist - error FList

errorParamterInfo - ParamInfo object

Returns:

ParamInfo Error Parameter Object

Throws:

EBufException

getStringWithParameterValues

public static String getStringWithParameterValues(String message,
                                                  Object... params)

Returns the string modified with parameters values

Parameters:

message - String with parameters ex: You must provide a valid {0} to create a service

params - parameters to be substituted ex: id

Returns:

Modified string with parameter values

getTimeOutConfiguration

public static int getTimeOutConfiguration()

Returns the timeOut value configured in the Configurations.xml file if timeOut is configured return its value otherwise return -1

Returns:

timeOut value

getInfranetFilePath

public static String getInfranetFilePath()

Get Infranet.properties file path. This utility checks if Infranet.properties file is present in weblogic domain directory then file pick from that location otherwise it will pick from user home directory. So same user can access different BRM server instance by putting Infranet.properties in respective weblogic domain

Returns:

Infranet.properties file path

getPropertyValue

public static String getPropertyValue(String propertyKey)

Get property value for the given key.

Parameters:

propertyKey -

Returns:

isValidURL

public static boolean isValidURL(String URL)

Check the given URL is valid or not. Basically it checks for the protocol and host.

Parameters:

URL -

Returns:

getFilePath

public static Path getFilePath(String filePath)

Converts a path string to a Path object.

Parameters:

filePath -

Returns:

path reference for given file path

getFilePath

public static Path getFilePath(URI uri)

Converts the given URI to a Path object.

Parameters:

uri -

Returns:

path reference for given file path

getUserHome

public static String getUserHome()

Returns user.home of system property.

Returns:

getConnectionWithoutTimeOut

public static PortalContext getConnectionWithoutTimeOut()
                                                 throws DeterminateException

Creates and returns single connection createConnections(int size) and getNewConnection(String name) uses this method to create a connection.

Returns:

PortalContext

Throws:

DeterminateException

closeConnectionWithoutTimeOut

public static void closeConnectionWithoutTimeOut(PortalContext ctx)

close the connection

Parameters:

ctx -

populateError

public static void populateError(ErrorConstants error,
                                 Response.Status status)

Populate the error passed with status code.

Parameters:

error -

status -

isPoid

public static Boolean isPoid(String id)
                      throws UnsupportedEncodingException

check if given id is BRM Poid or not

Parameters:

id -

Returns:

Throws:

UnsupportedEncodingException

getRecordFailureFlag

public static boolean getRecordFailureFlag()

Retrieves record failure flag configured in the Configurations.xml file.

Returns:

request record failure flag true or false