gov.grants.apply.util
Class ProcessorUtils

java.lang.Object
  extended bygov.grants.apply.util.ProcessorUtils

public final class ProcessorUtils
extends java.lang.Object

Author:
Grants.gov WebServices Team Common utilities shared by processors from different modes.

Constructor Summary
ProcessorUtils()
           
 
Method Summary
static void addAttachmentToResponse(javax.activation.DataSource dataSource, java.lang.String contentId, java.lang.String clientEncodingType)
          Adds and DataSource object as an attachment to the SOAP response.
static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.AssignAgencyTrackingNumberResponse prepareAssignAgencyTrackingNumberResponse(gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.ResponseMessage message, java.lang.String ggTrackNum)
          Creates Axis response object with a message and the Grants.gov tracking number.
static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.ConfirmApplicationDeliveryResponse prepareConfirmAppDeliveryResponse(gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.ResponseMessage message, java.lang.String ggTrackNum)
          Creates Axis response object with a message and the Grants.gov tracking number.
static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.GetApplicationListResponse prepareGetApplicationListResponse(IGetApplicationListBean[] apps)
          Creates an Axis response object with the given argument.
static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.GetApplicationResponse prepareGetApplicationResponse(GetApplicationBean bean)
          Creates the Axis generated response object for GetApplication WebService call.
static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.GetApplicationZipResponse prepareGetApplicationZipResponse(GetApplicationZipBean bean)
          Creates the Axis response object with the given bean argument.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessorUtils

public ProcessorUtils()
Method Detail

prepareGetApplicationListResponse

public static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.GetApplicationListResponse prepareGetApplicationListResponse(IGetApplicationListBean[] apps)
Creates an Axis response object with the given argument. If no apps were found (i.e. the apps argument is null), then a response with an empty list of ApplicationInformationType objects will be returned.

Parameters:
apps - A bean hold all necessary information to create the response object.
Returns:
The Axis response object.

prepareGetApplicationResponse

public static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.GetApplicationResponse prepareGetApplicationResponse(GetApplicationBean bean)
                                                                                                                        throws ProcessorException
Creates the Axis generated response object for GetApplication WebService call.

Parameters:
bean - Information for the response.
Throws:
ProcessorException

prepareAssignAgencyTrackingNumberResponse

public static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.AssignAgencyTrackingNumberResponse prepareAssignAgencyTrackingNumberResponse(gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.ResponseMessage message,
                                                                                                                                                       java.lang.String ggTrackNum)
Creates Axis response object with a message and the Grants.gov tracking number.

Parameters:
message - The success or failure message.
ggTrackNum - The Grants.gov tracking number of the application.
Returns:
The Axix response object.

prepareConfirmAppDeliveryResponse

public static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.ConfirmApplicationDeliveryResponse prepareConfirmAppDeliveryResponse(gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.ResponseMessage message,
                                                                                                                                               java.lang.String ggTrackNum)
Creates Axis response object with a message and the Grants.gov tracking number.

Parameters:
message - The success or failure message.
ggTrackNum - The Grants.gov tracking number of the application.
Returns:
The Axix response object.

prepareGetApplicationZipResponse

public static gov.grants.apply.WebServices.AgencyIntegrationServices_V1_0.GetApplicationZipResponse prepareGetApplicationZipResponse(GetApplicationZipBean bean)
Creates the Axis response object with the given bean argument. Also adds the zip to the SOAP attachment part of the message.

Parameters:
bean - Contains all required information to form the Axis response and the data source for the zip file.
Returns:
The Axis response.

addAttachmentToResponse

public static void addAttachmentToResponse(javax.activation.DataSource dataSource,
                                           java.lang.String contentId,
                                           java.lang.String clientEncodingType)
Adds and DataSource object as an attachment to the SOAP response.

Parameters:
dataSource - The attachment.
contentId - The content ID of the attachment.
Throws:
java.lang.UnsupportedOperationException - if this deployment of Axis is not configured for attachment support (mostly likely because the deployment is missing activation.jar and mail.jar).