Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SP-6633] - backport of PDI-20159 - prevent double encoding of spaces #9741

Open
wants to merge 1 commit into
base: 10.2
Choose a base branch
from
+205 −194
Open

[SP-6633] - backport of PDI-20159 - prevent double encoding of spaces #9741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
351 changes: 184 additions & 167 deletions plugins/rest/core/src/main/java/org/pentaho/di/trans/steps/rest/Rest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,22 @@ public Rest( StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr,
}

protected Object[] callRest( Object[] rowData ) throws KettleException {

Client client = null;
try {
client = getClient( rowData );
WebTarget webResource = buildRequest( client, rowData );
return invokeRequest( webResource, rowData );
} catch ( Exception e ) {
throw new KettleException( BaseMessages.getString( PKG, "Rest.Error.CanNotReadURL", data.realUrl ), e );
} finally {
if ( client != null ) {
client.close();
}
}
}

protected Client getClient( Object[] rowData ) throws KettleException {
// get dynamic url ?
if ( meta.isUrlInField() ) {
data.realUrl = data.inputRowMeta.getString( rowData, data.indexOfUrlField );
Expand All @@ -87,195 +103,196 @@ protected Object[] callRest( Object[] rowData ) throws KettleException {
throw new KettleException( BaseMessages.getString( PKG, "Rest.Error.MethodMissing" ) );
}
}
WebTarget webResource = null;
Client client = null;
Object[] newRow = null;
if ( rowData != null ) {
newRow = rowData.clone();
if ( isDetailed() ) {
logDetailed( BaseMessages.getString( PKG, "Rest.Log.ConnectingToURL", data.realUrl ) );
}
try {
if ( isDetailed() ) {
logDetailed( BaseMessages.getString( PKG, "Rest.Log.ConnectingToURL", data.realUrl ) );
}
// // Register a custom StringMessageBodyWriter to solve PDI-17423
ClientBuilder clientBuilder = ClientBuilder.newBuilder();
clientBuilder
.withConfig( data.config )
.property( HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true );
if ( meta.isIgnoreSsl() || !Utils.isEmpty( data.trustStoreFile ) ) {
clientBuilder.sslContext( data.sslContext );
clientBuilder.hostnameVerifier( ( s1, s2 ) -> true );
}
client = clientBuilder.build();
if ( data.basicAuthentication != null ) {
client.register( data.basicAuthentication );
}
// create a WebResource object, which encapsulates a web resource for the client
webResource = client.target( data.realUrl );

// used for calculating the responseTime
long startTime = System.currentTimeMillis();

if ( data.useMatrixParams ) {
// Add matrix parameters
UriBuilder builder = webResource.getUriBuilder();
for ( int i = 0; i < data.nrMatrixParams; i++ ) {
String value = data.inputRowMeta.getString( rowData, data.indexOfMatrixParamFields[ i ] );
if ( isDebug() ) {
logDebug(
// // Register a custom StringMessageBodyWriter to solve PDI-17423
ClientBuilder clientBuilder = ClientBuilder.newBuilder();
clientBuilder
.withConfig( data.config )
.property( HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true );
if ( meta.isIgnoreSsl() || !Utils.isEmpty( data.trustStoreFile ) ) {
clientBuilder.sslContext( data.sslContext );
clientBuilder.hostnameVerifier( ( s1, s2 ) -> true );
}
client = clientBuilder.build();
if ( data.basicAuthentication != null ) {
client.register( data.basicAuthentication );
}
return client;
}

protected WebTarget buildRequest( Client client, Object[] rowData ) throws KettleException {
WebTarget webResource = null;
// create a WebResource object, which encapsulates a web resource for the client
webResource = client.target( data.realUrl );

if ( data.useMatrixParams ) {
// Add matrix parameters
UriBuilder builder = webResource.getUriBuilder();
for ( int i = 0; i < data.nrMatrixParams; i++ ) {
String value = data.inputRowMeta.getString( rowData, data.indexOfMatrixParamFields[ i ] );
if ( isDebug() ) {
logDebug(
BaseMessages.getString( PKG, "Rest.Log.matrixParameterValue", data.matrixParamNames[ i ], value ) );
}
builder = builder.matrixParam( data.matrixParamNames[ i ],
UriComponent.encode( value, UriComponent.Type.QUERY_PARAM ) );
}
webResource = client.target( builder.build() );
builder = builder.matrixParam( data.matrixParamNames[ i ],
UriComponent.encode( value, UriComponent.Type.QUERY_PARAM_SPACE_ENCODED ) );
}
webResource = client.target( builder.build() );
}

if ( data.useParams ) {
// Add query parameters
for ( int i = 0; i < data.nrParams; i++ ) {
String value = data.inputRowMeta.getString( rowData, data.indexOfParamFields[ i ] );
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.queryParameterValue", data.paramNames[ i ], value ) );
}
webResource = webResource.queryParam( data.paramNames[ i ], UriComponent.encode( value, UriComponent.Type.QUERY_PARAM ) );
}
}
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.ConnectingToURL", webResource.getUri() ) );
}
Invocation.Builder invocationBuilder = webResource.request();
String contentType = null; // media type override, if not null
if ( data.useHeaders ) {
// Add headers
for ( int i = 0; i < data.nrheader; i++ ) {
String value = data.inputRowMeta.getString( rowData, data.indexOfHeaderFields[ i ] );

// unsure if an already set header will be returned to builder
invocationBuilder.header( data.headerNames[ i ], value );
if ( "Content-Type".equals( data.headerNames[ i ] ) ) {
contentType = value;
}
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.HeaderValue", data.headerNames[ i ], value ) );
}
if ( data.useParams ) {
// Add query parameters
for ( int i = 0; i < data.nrParams; i++ ) {
String value = data.inputRowMeta.getString( rowData, data.indexOfParamFields[ i ] );
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.queryParameterValue", data.paramNames[ i ], value ) );
}
webResource = webResource.queryParam( data.paramNames[ i ],
UriComponent.encode( value, UriComponent.Type.QUERY_PARAM_SPACE_ENCODED ) );
}
}
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.ConnectingToURL", webResource.getUri() ) );
}
return webResource;
}

private Object[] invokeRequest( WebTarget webResource, Object[] rowData ) throws KettleException {
Object[] newRow = null;
if ( rowData != null ) {
newRow = rowData.clone();
}

// used for calculating the responseTime
long startTime = System.currentTimeMillis();

Response response;
String entityString = "";
if ( data.useBody ) {
// Set Http request entity
entityString = Const.NVL( data.inputRowMeta.getString( rowData, data.indexOfBodyField ), "" );
Invocation.Builder invocationBuilder = webResource.request();

String contentType = null; // media type override, if not null
if ( data.useHeaders ) {
// Add headers
for ( int i = 0; i < data.nrheader; i++ ) {
String value = data.inputRowMeta.getString( rowData, data.indexOfHeaderFields[ i ] );

// unsure if an already set header will be returned to builder
invocationBuilder.header( data.headerNames[ i ], value );
if ( "Content-Type".equals( data.headerNames[ i ] ) ) {
contentType = value;
}
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.BodyValue", entityString ) );
logDebug( BaseMessages.getString( PKG, "Rest.Log.HeaderValue", data.headerNames[ i ], value ) );
}
}
try {
if ( data.method.equals( RestMeta.HTTP_METHOD_GET ) ) {
response = invocationBuilder.get( Response.class );
} else if ( data.method.equals( RestMeta.HTTP_METHOD_POST ) ) {
if ( null != contentType ) {
response = invocationBuilder.post( Entity.entity( entityString, contentType ) );
} else {
// response = builder.type( data.mediaType ).post( ClientResponse.class, entityString );
response = invocationBuilder.post( Entity.entity( entityString, data.mediaType ) );
}
} else if ( data.method.equals( RestMeta.HTTP_METHOD_PUT ) ) {
if ( null != contentType ) {
response = invocationBuilder.put( Entity.entity( entityString, contentType ) );
} else {
response = invocationBuilder.put( Entity.entity( entityString, data.mediaType ) );
}
} else if ( data.method.equals( RestMeta.HTTP_METHOD_DELETE ) ) {
response = invocationBuilder.delete();
} else if ( data.method.equals( RestMeta.HTTP_METHOD_HEAD ) ) {
response = invocationBuilder.head();
} else if ( data.method.equals( RestMeta.HTTP_METHOD_OPTIONS ) ) {
response = invocationBuilder.options();
} else if ( data.method.equals( RestMeta.HTTP_METHOD_PATCH ) ) {
if ( null != contentType ) {
response =
invocationBuilder.method(
}

Response response;
String entityString = "";
if ( data.useBody ) {
// Set Http request entity
entityString = Const.NVL( data.inputRowMeta.getString( rowData, data.indexOfBodyField ), "" );
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.BodyValue", entityString ) );
}
}
boolean debug = true;
try {
if ( data.method.equals( RestMeta.HTTP_METHOD_GET ) ) {
response = invocationBuilder.get( Response.class );
} else if ( data.method.equals( RestMeta.HTTP_METHOD_POST ) ) {
if ( null != contentType ) {
response = invocationBuilder.post( Entity.entity( entityString, contentType ) );
} else {
// response = builder.type( data.mediaType ).post( ClientResponse.class, entityString );
response = invocationBuilder.post( Entity.entity( entityString, data.mediaType ) );
}
} else if ( data.method.equals( RestMeta.HTTP_METHOD_PUT ) ) {
if ( null != contentType ) {
response = invocationBuilder.put( Entity.entity( entityString, contentType ) );
} else {
response = invocationBuilder.put( Entity.entity( entityString, data.mediaType ) );
}
} else if ( data.method.equals( RestMeta.HTTP_METHOD_DELETE ) ) {
response = invocationBuilder.delete();
} else if ( data.method.equals( RestMeta.HTTP_METHOD_HEAD ) ) {
response = invocationBuilder.head();
} else if ( data.method.equals( RestMeta.HTTP_METHOD_OPTIONS ) ) {
response = invocationBuilder.options();
} else if ( data.method.equals( RestMeta.HTTP_METHOD_PATCH ) ) {
if ( null != contentType ) {
response =
invocationBuilder.method(
RestMeta.HTTP_METHOD_PATCH, Entity.entity( entityString, contentType ) );
} else {
response =
invocationBuilder.method(
RestMeta.HTTP_METHOD_PATCH, Entity.entity( entityString, data.mediaType ) );
}
} else {
throw new KettleException( BaseMessages.getString( PKG, "Rest.Error.UnknownMethod", data.method ) );
response =
invocationBuilder.method(
RestMeta.HTTP_METHOD_PATCH, Entity.entity( entityString, data.mediaType ) );
}
} catch ( Exception e ) {
throw new KettleException( "Request could not be processed", e );
} else {
throw new KettleException( BaseMessages.getString( PKG, "Rest.Error.UnknownMethod", data.method ) );
}
// Get response time
long responseTime = System.currentTimeMillis() - startTime;
if ( isDetailed() ) {
logDetailed(
} catch ( Exception e ) {
throw new KettleException( "Request could not be processed", e );
}
// Get response time
long responseTime = System.currentTimeMillis() - startTime;
if ( isDetailed() ) {
logDetailed(
BaseMessages.getString( PKG, "Rest.Log.ResponseTime", String.valueOf( responseTime ), data.realUrl ) );
}
}

// Get status
int status = response.getStatus();
// Display status code
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.ResponseCode", "" + status ) );
}
// Get status
int status = response.getStatus();
// Display status code
if ( isDebug() ) {
logDebug( BaseMessages.getString( PKG, "Rest.Log.ResponseCode", "" + status ) );
}

// Get Response
String body;
String headerString = null;
try {
body = response.readEntity( String.class );
} catch ( Exception ex ) {
body = "";
}
// get Header
MultivaluedMap<String, Object> headers = searchForHeaders( response );
JSONObject json = new JSONObject();
for ( java.util.Map.Entry<String, List<Object>> entry : headers.entrySet() ) {
String name = entry.getKey();
List<Object> value = entry.getValue();
if ( value.size() > 1 ) {
json.put( name, value );
} else {
json.put( name, value.get( 0 ) );
}
}
headerString = json.toJSONString();
// for output
int returnFieldsOffset = data.inputRowMeta.size();
// add response to output
if ( !Utils.isEmpty( data.resultFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, body );
returnFieldsOffset++;
// Get Response
String body;
String headerString = null;
try {
body = response.readEntity( String.class );
} catch ( Exception ex ) {
body = "";
}
// get Header
MultivaluedMap<String, Object> headers = searchForHeaders( response );
JSONObject json = new JSONObject();
for ( java.util.Map.Entry<String, List<Object>> entry : headers.entrySet() ) {
String name = entry.getKey();
List<Object> value = entry.getValue();
if ( value.size() > 1 ) {
json.put( name, value );
} else {
json.put( name, value.get( 0 ) );
}
}
headerString = json.toJSONString();
// for output
int returnFieldsOffset = data.inputRowMeta.size();
// add response to output
if ( !Utils.isEmpty( data.resultFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, body );
returnFieldsOffset++;
}

// add status to output
if ( !Utils.isEmpty( data.resultCodeFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, new Long( status ) );
returnFieldsOffset++;
}
// add status to output
if ( !Utils.isEmpty( data.resultCodeFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, new Long( status ) );
returnFieldsOffset++;
}

// add response time to output
if ( !Utils.isEmpty( data.resultResponseFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, new Long( responseTime ) );
returnFieldsOffset++;
}
// add response header to output
if ( !Utils.isEmpty( data.resultHeaderFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, headerString );
}
} catch ( Exception e ) {
throw new KettleException( BaseMessages.getString( PKG, "Rest.Error.CanNotReadURL", data.realUrl ), e );
} finally {
if ( webResource != null ) {
webResource = null;
}
if ( client != null ) {
client.close();
}
// add response time to output
if ( !Utils.isEmpty( data.resultResponseFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, new Long( responseTime ) );
returnFieldsOffset++;
}
// add response header to output
if ( !Utils.isEmpty( data.resultHeaderFieldName ) ) {
newRow = RowDataUtil.addValueData( newRow, returnFieldsOffset, headerString );
}
return newRow;
}
Expand Down
Loading