COLDBOX-1311 #resolve

Remove direct calls to the servlet response.setStatus( int, String ) methods due to jakarta removing statusText

Author: lmajano

system/Bootstrap.cfc

@@ -354,7 +354,6 @@ component serializable="false" accessors="true" {
 							contentType     : !isNull( renderData.contentType ) ? renderData.contentType : getPageContextResponse().getContentType(),
 							encoding        : "UTF-8",
 							statusCode      : getPageContextResponse().getStatus(),
-							statusText      : "",
 							isBinary        : false,
 							responseHeaders : event.getResponseHeaders()
 						};
@@ -492,7 +491,7 @@ component serializable="false" accessors="true" {
 			else if ( isBoolean( variables.COLDBOX_FAIL_FAST ) && variables.COLDBOX_FAIL_FAST ) {
 				writeOutput( "Oops! Seems ColdBox is still not ready to serve requests, please try again." );
 				// You don't have to return a 500, I just did this so JMeter would report it differently than a 200
-				cfheader( statusCode = "503", statustext = "ColdBox Not Available Yet!" );
+				cfheader( statusCode = "503" );
 				// Break up!
 				return false;
 			}
@@ -707,14 +706,12 @@ component serializable="false" accessors="true" {
 	 *
 	 * @controller  The ColdBox controller
 	 * @statusCode  The status code to send
-	 * @statusText  The status text to send
 	 * @contentType The content type to send
 	 * @encoding    The content encoding
 	 */
 	private Bootstrap function renderDataSetup(
 		required controller,
 		required statusCode,
-		required statusText,
 		required contentType,
 		required encoding
 	){

system/RestHandler.cfc

@@ -135,7 +135,6 @@ component extends="EventHandler" {
 				data         = responseData,
 				contentType  = arguments.prc.response.getContentType(),
 				statusCode   = arguments.prc.response.getStatusCode(),
-				statusText   = arguments.prc.response.getStatusText(),
 				location     = arguments.prc.response.getLocation(),
 				isBinary     = arguments.prc.response.getBinary(),
 				jsonCallback = arguments.prc.response.getJsonCallback()
@@ -203,8 +202,7 @@ component extends="EventHandler" {
 			.setError( true )
 			.setData( {} )
 			.addMessage( "Base Handler Application Error: #arguments.exception.message#" )
-			.setStatusCode( arguments.event.STATUS.INTERNAL_ERROR )
-			.setStatusText( "General application error" );
+			.setStatusCode( arguments.event.STATUS.INTERNAL_ERROR );
 
 		// Development additions Great for Testing
 		if ( inDebugMode() ) {
@@ -222,7 +220,6 @@ component extends="EventHandler" {
 			data        = prc.response.getDataPacket( reset = this.resetDataOnError ),
 			contentType = prc.response.getContentType(),
 			statusCode  = prc.response.getStatusCode(),
-			statusText  = prc.response.getStatusText(),
 			location    = prc.response.getLocation(),
 			isBinary    = prc.response.getBinary()
 		);
@@ -255,16 +252,14 @@ component extends="EventHandler" {
 				isJSON( arguments.exception.extendedInfo ) ? deserializeJSON( arguments.exception.extendedInfo ) : ""
 			)
 			.addMessage( "Validation exceptions occurred, please see the data" )
-			.setStatusCode( arguments.event.STATUS.BAD_REQUEST )
-			.setStatusText( "Invalid Request" );
+			.setStatusCode( arguments.event.STATUS.BAD_REQUEST );
 
 		// Render Error Out
 		arguments.event.renderData(
 			type        = arguments.prc.response.getFormat(),
 			data        = arguments.prc.response.getDataPacket( reset = this.resetDataOnError ),
 			contentType = arguments.prc.response.getContentType(),
 			statusCode  = arguments.prc.response.getStatusCode(),
-			statusText  = arguments.prc.response.getStatusText(),
 			location    = arguments.prc.response.getLocation(),
 			isBinary    = arguments.prc.response.getBinary()
 		);
@@ -301,16 +296,14 @@ component extends="EventHandler" {
 			.addMessage(
 				len( exception.message ) ? exception.message : "The record you requested cannot be found in this system"
 			)
-			.setStatusCode( arguments.event.STATUS.NOT_FOUND )
-			.setStatusText( "Not Found" );
+			.setStatusCode( arguments.event.STATUS.NOT_FOUND );
 
 		// Render Error Out
 		arguments.event.renderData(
 			type        = arguments.prc.response.getFormat(),
 			data        = arguments.prc.response.getDataPacket( reset = this.resetDataOnError ),
 			contentType = arguments.prc.response.getContentType(),
 			statusCode  = arguments.prc.response.getStatusCode(),
-			statusText  = arguments.prc.response.getStatusText(),
 			location    = arguments.prc.response.getLocation(),
 			isBinary    = arguments.prc.response.getBinary()
 		);
@@ -339,16 +332,14 @@ component extends="EventHandler" {
 			.addMessage(
 				"InvalidHTTPMethod Execution of (#arguments.faultAction#): #arguments.event.getHTTPMethod()#"
 			)
-			.setStatusCode( arguments.event.STATUS.NOT_ALLOWED )
-			.setStatusText( "Invalid HTTP Method" );
+			.setStatusCode( arguments.event.STATUS.NOT_ALLOWED );
 
 		// Render Error Out
 		arguments.event.renderData(
 			type        = arguments.prc.response.getFormat(),
 			data        = arguments.prc.response.getDataPacket( reset = this.resetDataOnError ),
 			contentType = arguments.prc.response.getContentType(),
 			statusCode  = arguments.prc.response.getStatusCode(),
-			statusText  = arguments.prc.response.getStatusText(),
 			location    = arguments.prc.response.getLocation(),
 			isBinary    = arguments.prc.response.getBinary()
 		);
@@ -369,16 +360,14 @@ component extends="EventHandler" {
 			.getResponse()
 			.setError( true )
 			.addMessage( "Action '#arguments.missingAction#' could not be found" )
-			.setStatusCode( arguments.event.STATUS.NOT_FOUND )
-			.setStatusText( "Invalid Action" );
+			.setStatusCode( arguments.event.STATUS.NOT_FOUND );
 
 		// Render Error Out
 		arguments.event.renderData(
 			type        = arguments.prc.response.getFormat(),
 			data        = arguments.prc.response.getDataPacket( reset = this.resetDataOnError ),
 			contentType = arguments.prc.response.getContentType(),
 			statusCode  = arguments.prc.response.getStatusCode(),
-			statusText  = arguments.prc.response.getStatusText(),
 			location    = arguments.prc.response.getLocation(),
 			isBinary    = arguments.prc.response.getBinary()
 		);
@@ -422,7 +411,6 @@ component extends="EventHandler" {
 				.getResponse()
 				.setError( true )
 				.setStatusCode( arguments.event.STATUS.NOT_AUTHENTICATED )
-				.setStatusText( "Expired Authentication Credentials" )
 				.addMessage( "Expired Authentication Credentials" );
 			return;
 		}
@@ -431,7 +419,6 @@ component extends="EventHandler" {
 			.getResponse()
 			.setError( true )
 			.setStatusCode( arguments.event.STATUS.NOT_AUTHENTICATED )
-			.setStatusText( "Invalid or Missing Credentials" )
 			.addMessage( "Invalid or Missing Authentication Credentials" );
 
 		/**
@@ -440,8 +427,7 @@ component extends="EventHandler" {
 		if ( arguments.abort ) {
 			event.setHTTPHeader( name = "Content-Type", value = "application/json" );
 			event.setHTTPHeader(
-				statusCode = "#arguments.event.STATUS.NOT_AUTHENTICATED#",
-				statusText = "Invalid or Missing Credentials"
+				statusCode = "#arguments.event.STATUS.NOT_AUTHENTICATED#"
 			);
 
 			writeOutput( toJson( prc.response.getDataPacket( reset = this.resetDataOnError ) ) );
@@ -482,7 +468,6 @@ component extends="EventHandler" {
 			.getResponse()
 			.setError( true )
 			.setStatusCode( arguments.event.STATUS.NOT_AUTHORIZED )
-			.setStatusText( "Unauthorized Resource" )
 			.addMessage( "You are not allowed to access this resource" );
 
 		// Check for validator results
@@ -496,8 +481,7 @@ component extends="EventHandler" {
 		if ( arguments.abort ) {
 			event.setHTTPHeader( name = "Content-Type", value = "application/json" );
 			event.setHTTPHeader(
-				statusCode = "#arguments.event.STATUS.NOT_AUTHORIZED#",
-				statusText = "Not Authorized"
+				statusCode = "#arguments.event.STATUS.NOT_AUTHORIZED#"
 			);
 
 			writeOutput( serializeJSON( prc.response.getDataPacket( reset = this.resetDataOnError ) ) );
@@ -527,7 +511,6 @@ component extends="EventHandler" {
 			.getResponse()
 			.setError( true )
 			.setStatusCode( arguments.event.STATUS.NOT_FOUND )
-			.setStatusText( "Not Found" )
 			.addMessage( "The resource requested (#event.getCurrentRoutedURL()#) could not be found" );
 	}
 
@@ -586,8 +569,7 @@ component extends="EventHandler" {
 				} : {}
 			)
 			.addMessage( "An exception ocurred: #arguments.exception.message#" )
-			.setStatusCode( arguments.event.STATUS.INTERNAL_ERROR )
-			.setStatusText( "General application error" );
+			.setStatusCode( arguments.event.STATUS.INTERNAL_ERROR );
 	}
 
 	/**
@@ -613,7 +595,6 @@ component extends="EventHandler" {
 			.getResponse()
 			.setError( true )
 			.setStatusCode( arguments.event.STATUS.EXPECTATION_FAILED )
-			.setStatusText( "Expectation Failed" )
 			.addMessage( arguments.message );
 	}
 

system/testing/mock/web/context/MockRequestContext.cfc

@@ -16,7 +16,6 @@ component
 	 * return RequestContext
 	 *
 	 * @statusCode.hint the status code
-	 * @statusText.hint the status text
 	 * @name.hint       The header name
 	 * @value.hint      The header value
 	 * @charset.hint    The charset to use, defaults to UTF-8
@@ -25,7 +24,6 @@ component
 		// status code?
 		if ( !isNull( arguments.statusCode ) ) {
 			setStatusCode( arguments.statusCode );
-			setStatusText( arguments.statusText );
 		}
 		// Name Exists
 		else if ( structKeyExists( arguments, "name" ) ) {

system/web/Controller.cfc

@@ -848,8 +848,7 @@ component serializable="false" accessors="true" {
 				)
 			) {
 				oRequestContext.setHTTPHeader(
-					statusCode = 405,
-					statusText = "Invalid HTTP Method: '#oRequestContext.getHTTPMethod()#'"
+					statusCode = 405
 				);
 				// set Invalid HTTP method in context
 				oRequestContext.setIsInvalidHTTPMethod();
@@ -899,8 +898,7 @@ component serializable="false" accessors="true" {
 
 				// Throw Exception, no handlers defined
 				oRequestContext.setHTTPHeader(
-					statusCode = 405,
-					statusText = "Invalid HTTP Method: '#oRequestContext.getHTTPMethod()#'"
+					statusCode = 405
 				);
 				throw(
 					message = "Invalid HTTP Method: '#oRequestContext.getHTTPMethod()#'",

system/web/context/RequestContext.cfc

@@ -101,6 +101,7 @@ component serializable="false" accessors="true" {
 
 	/**
 	 * The last status text
+	 * @REMOVED by Jakarta EE, remove by 8
 	 */
 	property
 		name   ="statusText"
@@ -141,6 +142,7 @@ component serializable="false" accessors="true" {
 	};
 
 	// HTTP STATUS TEXTS
+	// TODO: REMOVE BY 8
 	this.STATUS_TEXTS = {
 		"100" : "Continue",
 		"101" : "Switching Protocols",

system/web/context/Response.cfc

@@ -82,14 +82,6 @@ component accessors="true" {
 		type   ="numeric"
 		default="200";
 
-	/**
-	 * The status text of the response
-	 */
-	property
-		name   ="statusText"
-		type   ="string"
-		default="OK";
-
 	/**
 	 * The response time
 	 */
@@ -106,6 +98,7 @@ component accessors="true" {
 	/**
 	 * Helper Status Texts Lookups
 	 */
+	// TODO: REMOVE BY 8
 	this.STATUS_TEXTS = {
 		"100" : "Continue",
 		"101" : "Switching Protocols",
@@ -186,7 +179,6 @@ component accessors="true" {
 		variables.jsonCallBack = "";
 		variables.contentType  = "";
 		variables.statusCode   = 200;
-		variables.statusText   = "OK";
 		variables.responsetime = 0;
 		variables.headers      = [];
 
@@ -288,20 +280,14 @@ component accessors="true" {
 	}
 
 	/**
-	 * Sets the status code with a statusText for the API response
+	 * Sets the status code for the API response
 	 *
 	 * @code The status code to be set
-	 * @text The status text to be set
 	 *
 	 * @return Returns the Response object for chaining
 	 */
-	Response function setStatus( required code, text ){
-		if ( isNull( arguments.text ) OR !len( arguments.text ) ) {
-			arguments.text = this.STATUS_TEXTS[ arguments.code ] ?: "";
-		}
-
+	Response function setStatus( required code ){
 		variables.statusCode = arguments.code;
-		variables.statusText = arguments.text;
 		return this;
 	}
 
@@ -328,20 +314,18 @@ component accessors="true" {
 	 *
 	 * @errorMessage The error message to set
 	 * @statusCode   The status code to set, if any
-	 * @statusText   The status text to set, if any
 	 *
 	 * @return Returns the Response object for chaining
 	 */
 	Response function setErrorMessage(
 		required errorMessage,
-		statusCode,
-		statusText = ""
+		statusCode
 	){
 		setError( true );
 		addMessage( arguments.errorMessage );
 
 		if ( !isNull( arguments.statusCode ) ) {
-			setStatus( arguments.statusCode, arguments.statusText );
+			setStatus( arguments.statusCode );
 		}
 
 		return this;

system/web/routing/Router.cfc

@@ -22,12 +22,12 @@ component
 	 ****************************************************************/
 
 	property
-		name    ="cachebox"  
+		name    ="cachebox"
 		inject  ="cachebox"
 		delegate="getCache";
 	property
 		name    ="controller"
-		inject  ="coldbox" 
+		inject  ="coldbox"
 		delegate="relocate,runEvent,runRoute";
 	property name="flash"  inject="coldbox:flash";
 	property name="logBox" inject="logbox";
@@ -822,7 +822,6 @@ component
 	 * @append                Whether the route should be appended or pre-pended to the array. By default we append to the end of the array
 	 * @response              An HTML response string to send back or a closure to be executed that should return the response. The closure takes in a 'params' struct of all matched params and the string will be parsed with the named value pairs as ${param}
 	 * @statusCode            The HTTP status code to send to the browser response.
-	 * @statusText            Explains the HTTP status code sent to the browser response.
 	 * @condition             A closure or UDF to execute that MUST return true to use route if matched or false and continue.
 	 * @name                  The name of the route
 	 * @domain                The domain to match, including wildcards
@@ -857,7 +856,6 @@ component
 		boolean append                = "true",
 		any response                  = "",
 		numeric statusCode            = 200,
-		string statusText             = "",
 		any condition                 = "",
 		string name                   = "",
 		string domain                 = "",
@@ -1243,7 +1241,6 @@ component
 			"response"              : "", // Do we have an inline response closure
 			"ssl"                   : false, // Are we forcing SSL
 			"statusCode"            : 200, // The response status code
-			"statusText"            : "Ok", // The response status text
 			"valuePairTranslation"  : true, // If we translate name-value pairs in the URL by convention
 			"verbs"                 : "", // The HTTP Verbs allowed
 			"view"                  : "", // The view to proxy to
@@ -1967,14 +1964,12 @@ component
 	 *
 	 * @body       The body of the response a lambda or closure
 	 * @statusCode The status code to use, defaults to 200
-	 * @statusText The status text to use, defaults to 'OK'
 	 *
 	 * @throws InvalidArgumentException
 	 */
 	function toResponse(
 		required body,
-		numeric statusCode = 200,
-		statusText         = "Ok"
+		numeric statusCode = 200
 	){
 		// Arg Check
 		if ( !isClosure( arguments.body ) && !isCustomFunction( arguments.body ) && !isSimpleValue( arguments.body ) ) {
@@ -1991,8 +1986,7 @@ component
 		variables.thisRoute.append(
 			{
 				response   : arguments.body,
-				statusCode : arguments.statusCode,
-				statusText : arguments.statusText
+				statusCode : arguments.statusCode
 			},
 			true
 		);