edu.psu.iam.cpr.core.service.helper.ServiceHelper.java Source code

Introduction

Here is the source code for edu.psu.iam.cpr.core.service.helper.ServiceHelper.java

Source

/* SVN FILE: $Id: ServiceHelper.java 5343 2012-09-27 14:56:40Z jvuccolo $ */
package edu.psu.iam.cpr.core.service.helper;

import javax.naming.NamingException;

import org.apache.log4j.Logger;
import org.hibernate.JDBCException;
import edu.psu.iam.cpr.core.database.Database;
import edu.psu.iam.cpr.core.database.SessionFactoryUtil;
import edu.psu.iam.cpr.core.error.CprException;
import edu.psu.iam.cpr.core.service.helper.ServiceCore;
import edu.psu.iam.cpr.core.service.helper.ServiceCoreReturn;

/**
 * Copyright 2012 The Pennsylvania State University
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
* @package edu.psu.iam.cpr.service.helper
* @author $Author: jvuccolo $
* @version $Rev: 5343 $
* @lastrevision $Date: 2012-09-27 10:56:40 -0400 (Thu, 27 Sep 2012) $
*/

public class ServiceHelper {

    /** Success message! */
    public static final String SUCCESS_MESSAGE = "Success!";
    private static final int BUFFER_SIZE = 1024;

    /**
     * Empty Constructor.
     */
    public ServiceHelper() {
        super();
    }

    /**
     * This function is used to initialize a service.
     * @param serviceName contains the name of the service.
     * @param ipAddress contains the ip address of the caller. 
     * @param principalId contains the principal identifier that is used to authenticate the service.
     * @param password contains the password associated with the principal.
     * @param updatedBy contains the user that either updated or requested information.
     * @param identifierType contains the identifier type used to find the user.
     * @param identifier contains the value of the identifier.
     * @param serviceCore contains the service core information.
     * @param db contains a reference to the database.
     * @param parameters contains the parameters associated with the services.
     * @return will return a ServiceCoreReturn object if successful.
     * @throws NamingException will be thrown if there is an LDAP authentication problem.
     * @throws CprException will be thrown if there are any CPR specific problems.
     */
    public ServiceCoreReturn initializeService(String serviceName, String ipAddress, String principalId,
            String password, String updatedBy, String identifierType, String identifier, ServiceCore serviceCore,
            Database db, StringBuilder parameters) throws CprException, NamingException {

        db.openSession(SessionFactoryUtil.getSessionFactory());
        return serviceCore.initializeService(db, principalId, password, updatedBy, identifierType, identifier,
                serviceName, ipAddress);
    }

    /**
     * This routine is used to handle generic exceptions.
     * @param log4jLogger contains a log4j Logger instance.
     * @param serviceCoreReturn contains the service core return instance.
     * @param db contains a database connection.
     * @param e Contains the generic exception.
     */
    public void handleOtherException(Logger log4jLogger, ServiceCoreReturn serviceCoreReturn, Database db,
            Exception e) {
        log4jLogger.info("Exception: " + e.getMessage());
        db.rollbackSession();
    }

    /**
     * This routine is used to handle exceptions of the JDBC type.
     * @param log4jLogger contains a log4j Logger instance.
     * @param serviceCoreReturn contains the service core return instance.
     * @param db contains a database connection.
     * @param e contains the JDBCEXception exception information.
     * @return contains the formatted String.
     */
    public String handleJDBCException(Logger log4jLogger, ServiceCoreReturn serviceCoreReturn, Database db,
            JDBCException e) {

        String sqlState = e.getSQLState();
        sqlState = (sqlState == null) ? "N/A" : sqlState;
        int errorCode = e.getErrorCode();
        String exceptionMessage = e.getMessage();
        exceptionMessage = (exceptionMessage == null) ? "EMPTY" : exceptionMessage;

        final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
        sb.append("Database Exception: ");
        sb.append("Message = ");
        sb.append(exceptionMessage);
        sb.append(", Error Code = ");
        sb.append(errorCode);
        sb.append(", SQL State = ");
        sb.append(sqlState);

        String formattedException = sb.toString();
        log4jLogger.info(formattedException);
        db.rollbackSession();
        return formattedException;
    }

    /**
     * This routine is used to handle a CPR specific exception.
     * @param log4jLogger contains an instance of a log4j Logger.
     * @param serviceCoreReturn contains the service core instance.
     * @param db contains a database instance.
     * @param e contains the CPR specfic exception information.
     * @return will return a formatted string of the exception.
     */
    public String handleCprException(Logger log4jLogger, ServiceCoreReturn serviceCoreReturn, Database db,
            CprException e) {
        String errorMessage = e.getReturnType().message();
        if (e.getParameterValue() != null) {
            errorMessage = String.format(errorMessage, e.getParameterValue());
        }
        log4jLogger.info("CPR Exception: " + e.getReturnType().toString() + ", Message: " + errorMessage);
        db.rollbackSession();
        return errorMessage;
    }
}