cz.ues.platform.sysc.usecase.util

Class HTTPURLBuilder

java.lang.Object

cz.ues.platform.sysc.usecase.util.HTTPURLBuilder

public final class HTTPURLBuilder
extends java.lang.Object

This class is used for creation of URL or its part used for navigation according Use Case.

Since:

UES7-00

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,java.lang.Object>	EMPTY_PARAMETERS Empty map with parameters.
private UESEntityType	etSvc Reference to UES entity type.
private UESLogger	logger Reference to UES logger used in this class.
private static java.lang.String	PARAM_ACTION This parameter is dependent to code in cz.unicorn.afu_v1.af_v1.appc_v1.ucm_v3.action.UESExpectedActionImpl#toString().
private static java.lang.String	PARAM_SESSION_FREE_LINK Parameter name for session free link.
static java.lang.String	UC_DEFAULT Code for default Use Case.
private static java.lang.String	UC_PREFIX This prefix specifies that a string contains use case.
private UESUseCaseProvider	ucProvider Reference to Use Case provider.
private static java.lang.String	URL_PARAMETERS_PART_SEPARATOR Separator in URL which determines URL part containing parameters.
private static java.lang.String	URL_PARAMETERS_SEPARATOR Separator used for separate parameters in URL.
private static java.lang.String	URL_VALUE_SEPARATOR Separator for separate parameter name from parameter value.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HTTPURLBuilder() Creates a new instance of HTTPURLBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
private UESURI	addParameters(UESURI uri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates UESURI from specified UESURI and passed map of parameters.
private java.lang.String	createUrl(java.lang.String urlPrefix, java.lang.String actionPart) Creates URL from URL prefix and part for Use Case.
private java.lang.String	encodeForHttp(java.lang.String value) Encodes string to form suitable for passing into web link.
private java.lang.String	formatUCQueryPart(UESURI useCaseUri) Converts UESURI of Use Case to String form.
private UESURIPart	getDefaultUseCase() Returns Use Case UESURIPart for default Use Case.
java.lang.String	getHref(java.lang.String urlPrefix, java.lang.String useCase, UESURI mainEntityUri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates string convenient to be used in attribute href of HTML link.
java.lang.String	getHref(java.lang.String urlPrefix, UESURI useCaseUri) Creates string convenient to be used in attribute href of HTML link.
java.lang.String	getHref(java.lang.String urlPrefix, UESURI useCaseUri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates string convenient to be used in attribute href of HTML link.
java.lang.String	getHref(java.lang.String urlPrefix, UESURI useCaseUri, UESURI mainEntityUri) Creates string convenient to be used in attribute href of HTML link.
java.lang.String	getHref(java.lang.String urlPrefix, UESURI useCaseUri, UESURI mainEntityUri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates string convenient to be used in attribute href of HTML link.
static HTTPURLBuilder	getInstance() Returns instance of HTTPURLBuilder.
private UESURIPart	getUseCase(java.lang.String useCase) Extracts Use Case from string.
java.lang.String	getUseCaseQueryPart(java.lang.String useCase, UESURI mainEntityUri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates query part (convenient to be used within attribute href of HTML link) according to passed Use Case UESURI, UESURI of main entity and additional parameters for the main entity UESURI.
java.lang.String	getUseCaseQueryPart(UESURI useCaseUri) Creates query part (convenient to be used within attribute href of HTML link) according to Use Case specified by UESURI.
java.lang.String	getUseCaseQueryPart(UESURI useCaseUri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates query part (convenient to be used within attribute href of HTML link) for Use Case specified by UESURI and supplemented with passed additional parameters.
java.lang.String	getUseCaseQueryPart(UESURI useCaseUri, UESURI mainEntityUri) Creates query part (convenient to be used within attribute href of HTML link) according to passed Use Case UESURI and UESURI of main entity.
java.lang.String	getUseCaseQueryPart(UESURI useCaseUri, UESURI mainEntityUri, java.util.Map<java.lang.String,java.lang.Object> parameters) Creates query part (convenient to be used within attribute href of HTML link) according to passed Use Case UESURI (supplemented with passed additional parameters) and UESURI of main entity.
private UESURI	getUseCaseUri(UESURI useCaseUri, UESURI mainEntity) Creates Use Case UESURI in form ues:terr:entity?
private boolean	checkMainEntityType(UESURI useCaseUri, UESURI mainEntity) Checks entity type of specified main entity according to entity type of Use Case.
private boolean	isDefined(java.lang.String id) Tests whether is passed id not null and not empty.
private UESURI	updateUseCaseUri(UESURI useCaseUri) Sets default Use Case part if there is no Use Case part in passed UESURI.

Methods inherited from class java.lang.Object

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

Field Detail

UC_DEFAULT

public static final UC_DEFAULT

Code for default Use Case.

See Also:

Constant Field Values

URL_PARAMETERS_PART_SEPARATOR

private static final URL_PARAMETERS_PART_SEPARATOR

Separator in URL which determines URL part containing parameters.

See Also:

Constant Field Values

URL_PARAMETERS_SEPARATOR

private static final URL_PARAMETERS_SEPARATOR

Separator used for separate parameters in URL.

See Also:

Constant Field Values

URL_VALUE_SEPARATOR

private static final URL_VALUE_SEPARATOR

Separator for separate parameter name from parameter value.

See Also:

Constant Field Values

PARAM_ACTION

private static final PARAM_ACTION

This parameter is dependent to code in cz.unicorn.afu_v1.af_v1.appc_v1.ucm_v3.action.UESExpectedActionImpl#toString().

See Also:

Constant Field Values

PARAM_SESSION_FREE_LINK

private static final PARAM_SESSION_FREE_LINK

Parameter name for session free link.

See Also:

Constant Field Values

EMPTY_PARAMETERS

private static final EMPTY_PARAMETERS

Empty map with parameters.

UC_PREFIX

private static final UC_PREFIX

This prefix specifies that a string contains use case.

See Also:

Constant Field Values

ucProvider

private ucProvider

Reference to Use Case provider.

logger

private logger

Reference to UES logger used in this class.

etSvc

private etSvc

Reference to UES entity type.

Constructor Detail

HTTPURLBuilder

private HTTPURLBuilder()

Creates a new instance of HTTPURLBuilder.

Since:

UES7-00

Method Detail

getInstance

public static HTTPURLBuilder getInstance()

Returns instance of HTTPURLBuilder.

Returns:

instance of HTTPURLBuilder.

Since:

UES7-00

getUseCaseQueryPart

public java.lang.String getUseCaseQueryPart(UESURI useCaseUri)
throws UESHTTPURLBuilderRTException

Creates query part (convenient to be used within attribute href of HTML link) according to Use Case specified by UESURI.

The resulting string will have following form: "action=encoded_UESURI&SessFree=encoded_UESURI" where the encoded_UESURI is the Use Case UESURI converted into string and encoded to the application/x-www-form-urlencoded MIME format.

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 UESURI ucUri = ...;
 String queryPart = httpUrlBuilder.getUseCaseQueryPart(ucUri);
 String href = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&" + queryPart;
 ... 
 

Parameters:

useCaseUri - UESURI of use case in one of following forms:

• ues:territory:entity
• ues:territory:entity?use_case

If there is no Use Case part in the Use Case UESURI, default Use Case will be added.

Returns:

UESURI converted into string convenient to be used within HTML link suitable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the Use Case doesn't exist in Use Case Registry.

Since:

UES7-00

getUseCaseQueryPart

public java.lang.String getUseCaseQueryPart(UESURI useCaseUri,
java.util.Map<java.lang.String,java.lang.Object> parameters)
throws UESHTTPURLBuilderRTException

Creates query part (convenient to be used within attribute href of HTML link) for Use Case specified by UESURI and supplemented with passed additional parameters.

The resulting string will have following form: "action=encoded_UESURI&SessFree=encoded_UESURI" where the encoded_UESURI is the Use Case UESURI (supplemented with passed additional parameters) converted into string and encoded to the application/x-www-form-urlencoded MIME format.

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 UESURI ucUri = ...;
 Map<String, Object> parameters = ...;
 String queryPart = httpUrlBuilder.getUseCaseQueryPart(ucUri, parameters);
 String href = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&" + queryPart;
 ... 
 

Parameters:

useCaseUri - UESURI of use case in one of following forms:

• ues:territory:entity
• ues:territory:entity?use_case

If there is no Use Case part in the Use Case UESURI, default Use Case will be added.

parameters - Additional parameters. The additional parameters will be added to the Use Case UESURI. These parameter may override parameters in the Use Case UESURI.

Returns:

UESURI converted into string convenient to be used within HTML link suitable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the Use Case doesn't exist in Use Case Registry.

Since:

UES7-00

getUseCaseQueryPart

public java.lang.String getUseCaseQueryPart(UESURI useCaseUri,
UESURI mainEntityUri)
throws UESHTTPURLBuilderRTException

Creates query part (convenient to be used within attribute href of HTML link) according to passed Use Case UESURI and UESURI of main entity.

The resulting string will have following form: "action=encoded_UESURI&SessFree=encoded_UESURI" where the encoded_UESURI is the Use Case UESURI converted into string and encoded to the application/x-www-form-urlencoded MIME format.

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 UESURI ucUri = UESURI.parseURI("ues:terr:entity_type:use_case");
 UESURI mainEntityUri = UESURI.parseURI("ues:terr:entity");
 String queryPart = httpUrlBuilder.getUseCaseQueryPart(ucUri, mainEntityUri);
 String href = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&" + queryPart;
 ... 
 

Parameters:

useCaseUri - UESURI of use case in form ues:territory:entity_type:use_case.

mainEntityUri - UESURI of main entity. This UESURI should not contain Use Case part.

Returns:

String convenient to be used within URL link usable to execute the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the UESURI of main entity is null or no Use Case can be obtained from Use Case Registry.

Since:

UES7-00

getUseCaseQueryPart

public java.lang.String getUseCaseQueryPart(UESURI useCaseUri,
UESURI mainEntityUri,
java.util.Map<java.lang.String,java.lang.Object> parameters)
throws UESHTTPURLBuilderRTException

Creates query part (convenient to be used within attribute href of HTML link) according to passed Use Case UESURI (supplemented with passed additional parameters) and UESURI of main entity.

The resulting string will have following form: "action=encoded_UESURI&SessFree=encoded_UESURI" where the encoded_UESURI is the Use Case UESURI (supplemented with passed additional parameters) converted into string and encoded to the application/x-www-form-urlencoded MIME format.

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 Map<String, Object> parameters = ...;
 UESURI ucUri = UESURI.parseURI("ues:terr:entity_type:use_case");
 UESURI mainEntityUri = UESURI.parseURI("ues:terr:entity");
 String queryPart = httpUrlBuilder.getUseCaseQueryPart(ucUri, mainEntityUri, parameters);
 String href = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&" + queryPart;
 ... 
 

Parameters:

useCaseUri - UESURI of use case in form ues:territory:entity_type:use_case.

mainEntityUri - UESURI of main entity. This UESURI should not contain Use Case part.

parameters - Additional parameters. The additional parameters will be added to the Use Case UESURI. These parameter may override parameters in the Use Case UESURI.

Returns:

String convenient to be used within URL link usable to execute the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the UESURI of main entity is null or no Use Case can be obtained from Use Case Registry.

Since:

UES7-00

getUseCaseQueryPart

public java.lang.String getUseCaseQueryPart(java.lang.String useCase,
UESURI mainEntityUri,
java.util.Map<java.lang.String,java.lang.Object> parameters)
throws UESHTTPURLBuilderRTException

Creates query part (convenient to be used within attribute href of HTML link) according to passed Use Case UESURI, UESURI of main entity and additional parameters for the main entity UESURI.

The resulting string will have following form: "action=encoded_UESURI&SessFree=encoded_UESURI" where the encoded_UESURI is the Use Case UESURI (supplemented with passed additional parameters) converted into string and encoded to the application/x-www-form-urlencoded MIME format.

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 Map<String, Object> parameters = ...;
 UESURI ucUri = UESURI.parseURI("ues:terr:entity_type:use_case");
 UESURI mainEntityUri = UESURI.parseURI("ues:terr:entity");
 String queryPart = httpUrlBuilder.getUseCaseQueryPart(ucUri, mainEntityUri, parameters);
 String href = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&" + queryPart;
 ... 
 

Parameters:

useCase - Use Case specified by prefix uesuc:.

mainEntityUri - UESURI of main entity. This UESURI should not contain Use Case part.

parameters - Additional parameters. The additional parameters will be added to the Use Case UESURI. These parameter may override parameters in the Use Case UESURI.

Returns:

String convenient to be used within URL link usable to execute the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the Use Case doesn't exist in Use Case Registry or the useCase parameter doesn't identify any Use Case.

Since:

UES7-00

getHref

public java.lang.String getHref(java.lang.String urlPrefix,
UESURI useCaseUri)
throws UESHTTPURLBuilderRTException

Creates string convenient to be used in attribute href of HTML link. This link will execute the use case (if it is used for navigation).

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 UESURI ucUri = UESURI.parseURI("ues:terr:entity?use_case");
 String urlPrefix = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&";
 String href = httpUrlBuilder.getHref(urlPrefix, ucUri);
 ... 
 

Parameters:

urlPrefix - Prefix of the final string.

useCaseUri - UESURI of use case in one of following forms:

• ues:territory:entity
• ues:territory:entity?use_case

If there is no Use Case part in the Use Case UESURI, default Use Case will be added.

Returns:

String convenient to be used within HTML link usable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the Use Case doesn't exist in Use Case Registry.

Since:

UES7-00

getHref

public java.lang.String getHref(java.lang.String urlPrefix,
UESURI useCaseUri,
java.util.Map<java.lang.String,java.lang.Object> parameters)
throws UESHTTPURLBuilderRTException

Creates string convenient to be used in attribute href of HTML link. This link will execute the Use Case (if it is used for navigation).

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 Map<String,Object> parameters = ...;
 UESURI ucUri = UESURI.parseURI("ues:terr:entity?use_case");
 String urlPrefix = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&";
 String href = httpUrlBuilder.getHref(urlPrefix, ucUri, parameters);
 ... 
 

Parameters:

urlPrefix - Prefix of the final string.

useCaseUri - UESURI of use case in one of following forms:

• ues:territory:entity
• ues:territory:entity?use_case

If there is no Use Case part in the Use Case UESURI, default Use Case will be added.

parameters - Additional parameters. The additional parameters will be added to the Use Case UESURI. These parameter may override parameters in the Use Case UESURI.

Returns:

String convenient to be used within HTML link usable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the Use Case doesn't exist in Use Case Registry.

Since:

UES7-00

getHref

public java.lang.String getHref(java.lang.String urlPrefix,
UESURI useCaseUri,
UESURI mainEntityUri)
throws UESHTTPURLBuilderRTException

Creates string convenient to be used in attribute href of HTML link. This link will execute the Use Case (if it is used for navigation).

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 UESURI ucUri = UESURI.parseURI("ues:territory:entity_type:use_case");
 UESURI mainEntityUri = UESURI.parseURI("ues:terr:entity");
 String urlPrefix = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&";
 String href = httpUrlBuilder.getHref(urlPrefix, ucUri, mainEntityUri);
 ... 
 

Parameters:

urlPrefix - Prefix of the final string.

useCaseUri - UESURI of use case in form ues:territory:entity_type:use_case.

mainEntityUri - UESURI of main entity. This UESURI should not contain Use Case part.

Returns:

String convenient to be used within HTML link usable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the UESURI of main entity is null or no Use Case can be obtained from Use Case Registry.

Since:

UES7-00

getHref

public java.lang.String getHref(java.lang.String urlPrefix,
UESURI useCaseUri,
UESURI mainEntityUri,
java.util.Map<java.lang.String,java.lang.Object> parameters)
throws UESHTTPURLBuilderRTException

Creates string convenient to be used in attribute href of HTML link. This link will execute the Use Case (if it is used for navigation).

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 Map<String,Object> parameters = ...;
 UESURI ucUri = UESURI.parseURI("ues:territory:entity_type:use_case");
 UESURI mainEntityUri = UESURI.parseURI("ues:terr:entity");
 String urlPrefix = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&";
 String href = httpUrlBuilder.getHref(urlPrefix, ucUri, mainEntityUri, parameters);
 ... 
 

Parameters:

urlPrefix - Prefix of the final string.

useCaseUri - UESURI of use case in form ues:territory:entity_type:use_case.

mainEntityUri - UESURI of main entity. This UESURI should not contain Use Case part.

parameters - Additional parameters. The additional parameters will be added to the Use Case UESURI. These parameter may override parameters in the Use Case UESURI.

Returns:

String convenient to be used within HTML link usable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case UESURI is null or the UESURI of main entity is null or no Use Case can be obtained from Use Case Registry.

Since:

UES7-00

getHref

public java.lang.String getHref(java.lang.String urlPrefix,
java.lang.String useCase,
UESURI mainEntityUri,
java.util.Map<java.lang.String,java.lang.Object> parameters)
throws UESHTTPURLBuilderRTException

Creates string convenient to be used in attribute href of HTML link. This link will execute the Use Case (if it is used for navigation).

Usage example:

 ...
 HTTPURLBuilder httpUrlBuilder = HTTPURLBuilder.getInstance();
 Map<String,Object> parameters = ...;
 UESURI useCase = "uesuc:use_case";
 UESURI mainEntityUri = UESURI.parseURI("ues:terr:entity");
 String urlPrefix = "https://plus4u.net/ues/sesm;jsessionid=...?REQID=...&WINID=...&ref=...&";
 String href = httpUrlBuilder.getHref(urlPrefix, useCase, mainEntityUri, parameters);
 ... 
 

Parameters:

urlPrefix - Prefix of the final string.

useCase - Use Case specified by prefix uesuc:.

mainEntityUri - UESURI of main entity. This UESURI should not contain Use Case part.

parameters - Additional parameters. The additional parameters will be added to the Use Case UESURI. These parameter may override parameters in the Use Case UESURI.

Returns:

String convenient to be used within HTML link usable for execution of the Use Case.

Throws:

UESHTTPURLBuilderRTException - If either the Use Case doesn't identify any Use Case or the UESURI of main entity is null or no Use Case can be obtained from Use Case Registry.

Since:

UES7-00

getUseCaseUri

private UESURI getUseCaseUri(UESURI useCaseUri,
UESURI mainEntity)

Creates Use Case UESURI in form ues:terr:entity?useCase.

Parameters:

useCaseUri - Use Case UESURI. This UESURI must be in form ues:#{system}:entityType:useCase.

mainEntity - UESURI of main entity.

Returns:

Use Case UESURI in form ues:terr:entity?useCase.

Since:

UES7-00

checkMainEntityType

private boolean checkMainEntityType(UESURI useCaseUri,
UESURI mainEntity)

Checks entity type of specified main entity according to entity type of Use Case.

Parameters:

useCaseUri - Use Case UESURI.

mainEntity - Main entity UESURI.

Returns:

The value true if the entity type of main entity is the same as entity type of the Use Case or it is the child of

Since:

UES7-00

createUrl

private java.lang.String createUrl(java.lang.String urlPrefix,
java.lang.String actionPart)

Creates URL from URL prefix and part for Use Case.

Parameters:

urlPrefix - URL prefix. This parameter cannot be null or empty.

actionPart - Use Case part.

Returns:

URL which contains use case part.

Since:

UES7-00

formatUCQueryPart

private java.lang.String formatUCQueryPart(UESURI useCaseUri)

Converts UESURI of Use Case to String form. This encoded string is suitable to be used within HTML link.

Parameters:

useCaseUri - Use Case UESURI.

Returns:

Use Case UESURI formated in string suitable to be used within HTML link.

Since:

UES7-00

encodeForHttp

private java.lang.String encodeForHttp(java.lang.String value)

Encodes string to form suitable for passing into web link.

Parameters:

value - String to convert.

Returns:

Encoded string.

Since:

UES7-00

addParameters

private UESURI addParameters(UESURI uri,
java.util.Map<java.lang.String,java.lang.Object> parameters)

Creates UESURI from specified UESURI and passed map of parameters.

Parameters:

uri - UESURI.

parameters - Parameters to be merged into the UESURI.

Returns:

UESURI with merged parameters.

Since:

UES7-00

updateUseCaseUri

private UESURI updateUseCaseUri(UESURI useCaseUri)

Sets default Use Case part if there is no Use Case part in passed UESURI.

Parameters:

useCaseUri - Use Case UESURI.

Returns:

UESURI with Use Case part specified.

Since:

UES7-00

getDefaultUseCase

private UESURIPart getDefaultUseCase()

Returns Use Case UESURIPart for default Use Case.

Returns:

UESURIPart for default Use Case.

Since:

UES7-00

isDefined

private boolean isDefined(java.lang.String id)

Tests whether is passed id not null and not empty.

Parameters:

id - Tested Id.

Returns:

The value true if the passed Id is not null and not empty; otherwise the value false.

Since:

UES7-00

getUseCase

private UESURIPart getUseCase(java.lang.String useCase)

Extracts Use Case from string. The string should like uesuc:UseCase.

Parameters:

useCase - String with Use Case.

Returns:

Reference to Use Case UESURI part or the value null if the Use Case UESURI part cannot be parsed (e.g. it is null or it has unexpected format).

Since:

UES7-00