@ -10,7 +10,8 @@ import javax.xml.parsers.DocumentBuilderFactory;
import org.gcube.common.resources.gcore.utils.XPathHelper ; import org.gcube.common.resources.gcore.utils.XPathHelper ;
import org.gcube.common.scope.api.ScopeProvider ; import org.gcube.common.scope.api.ScopeProvider ;
import org.gcube.portlets.user.workspace.server.util.WsUtil ; import org.gcube.common.scope.impl.ScopeBean ;
import org.gcube.common.scope.impl.ScopeBean.Type ;
import org.gcube.resources.discovery.client.api.DiscoveryClient ; import org.gcube.resources.discovery.client.api.DiscoveryClient ;
import org.gcube.resources.discovery.client.queries.api.Query ; import org.gcube.resources.discovery.client.queries.api.Query ;
import org.gcube.resources.discovery.client.queries.impl.QueryBox ; import org.gcube.resources.discovery.client.queries.impl.QueryBox ;
@ -19,12 +20,11 @@ import org.slf4j.LoggerFactory;
import org.w3c.dom.Node ; import org.w3c.dom.Node ;
import org.xml.sax.InputSource ; import org.xml.sax.InputSource ;
/ * * / * *
* The Class ApplicationProfileReader .
* The Class ApplicationProfileReader .
*
*
* @author Francesco Mangiacrapa francesco . mangiacrapa { @literal @ } isti . cnr . it
* @author Francesco Mangiacrapa francesco . mangiacrapa { @literal @ } isti . cnr . it
* Sep 14 , 2016
* Sep 14 , 2016
* /
* /
public class ApplicationProfileReader { public class ApplicationProfileReader {
@ -48,12 +48,26 @@ public class ApplicationProfileReader {
private String resourceName ;
private String resourceName ;
private String appID ;
private String appID ;
public enum APPLICATION_PROFILE_ITEM {
SCOPE ( "/Scope/text()" ) , URL ( "/URL/text()" ) ;
private String xPath ;
APPLICATION_PROFILE_ITEM ( String xpath ) {
this . xPath = xpath ;
}
public String getXPath ( ) {
return xPath ;
}
}
/ * *
/ * *
* Instantiates a new application profile reader .
* Instantiates a new application profile reader .
*
*
* @param resourceName the resource name
* @param resourceName the resource name
* @param appID the app id
* @param appID the app id
* @throws Exception the exception
* @throws Exception the exception
* /
* /
public ApplicationProfileReader ( String resourceName , String appID ) throws Exception {
public ApplicationProfileReader ( String resourceName , String appID ) throws Exception {
@ -64,150 +78,167 @@ public class ApplicationProfileReader {
this . scope = ScopeProvider . instance . get ( ) ;
this . scope = ScopeProvider . instance . get ( ) ;
}
}
/ * *
/ * *
* this method looks up the generic resource among the ones available in the infrastructure using scope provider { @link ScopeProvider . instance . get ( ) }
* this method looks up the generic resource among the ones available in the
* resource name { @value # WORKSPACE_EXPLORER_APP_NAME } and secondaryType { @value # SECONDARY_TYPE }
* infrastructure using scope provider { @link ScopeProvider . instance . get ( ) }
* resource name { @value # WORKSPACE_EXPLORER_APP_NAME } and secondaryType
* { @value # SECONDARY_TYPE }
*
*
* @return the applicationProfile profile
* @return the applicationProfile profile
* /
* /
/ * *
/ * *
* this method looks up the applicationProfile profile among the ones available in the infrastructure .
* this method looks up the applicationProfile profile among the ones available
* in the infrastructure .
*
*
* @return the applicationProfile profile
* @return the applicationProfile profile
* /
* /
public ApplicationProfile readProfileFromInfrastrucure ( ) {
public ApplicationProfile readProfileFromInfrastrucure ( ) {
ApplicationProfile appProf = new ApplicationProfile ( ) ;
ApplicationProfile appProf = new ApplicationProfile ( ) ;
String queryString = getGcubeGenericQueryString ( secondaryType , appID ) ;
String queryString = getGcubeGenericQueryString ( secondaryType , appID ) ;
try {
try {
if ( scope = = null )
if ( scope = = null )
throw new Exception ( "Scope is null, set scope into ScopeProvider" ) ;
throw new Exception ( "Scope is null, set scope into ScopeProvider" ) ;
logger . info ( "Trying to fetch ApplicationProfile in the scope: " + scope + ", SecondaryType: " + secondaryType + ", AppId: " + appID ) ;
logger . info ( "Trying to fetch " + SECONDARY_TYPE + " in the scope: " + scope + ", SecondaryType: "
Query q = new QueryBox ( queryString ) ;
+ secondaryType + ", AppId: " + appID ) ;
DiscoveryClient < String > client = client ( ) ;
Query q = new QueryBox ( queryString ) ;
List < String > appProfile = client . submit ( q ) ;
DiscoveryClient < String > client = client ( ) ;
List < String > appProfile = client . submit ( q ) ;
if ( appProfile = = null | | appProfile . size ( ) = = 0 )
throw new ApplicationProfileNotFoundException ( "ApplicationProfile with SecondaryType: " + secondaryType + ", AppId: " + appID + " is not registered in the scope: " + scope ) ;
if ( appProfile = = null | | appProfile . size ( ) = = 0 )
else {
throw new ApplicationProfileNotFoundException ( "Generic Resource with SecondaryType: " + secondaryType
String elem = appProfile . get ( 0 ) ;
+ ", AppId: " + appID + " is not registered in the scope: " + scope ) ;
DocumentBuilder docBuilder = DocumentBuilderFactory . newInstance ( ) . newDocumentBuilder ( ) ;
else {
Node node = docBuilder . parse ( new InputSource ( new StringReader ( elem ) ) ) . getDocumentElement ( ) ;
String elem = appProfile . get ( 0 ) ;
XPathHelper helper = new XPathHelper ( node ) ;
DocumentBuilder docBuilder = DocumentBuilderFactory . newInstance ( ) . newDocumentBuilder ( ) ;
Node node = docBuilder . parse ( new InputSource ( new StringReader ( elem ) ) ) . getDocumentElement ( ) ;
List < String > currValue = null ;
XPathHelper helper = new XPathHelper ( node ) ;
currValue = helper . evaluate ( RESOURCE_PROFILE_NAME_TEXT ) ;
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
List < String > currValue = null ;
appProf . setName ( currValue . get ( 0 ) ) ;
currValue = helper . evaluate ( RESOURCE_PROFILE_NAME_TEXT ) ;
}
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
else throw new ApplicationProfileNotFoundException ( "Your applicationProfile NAME was not found in the profile" ) ;
appProf . setName ( currValue . get ( 0 ) ) ;
} else
currValue = helper . evaluate ( RESOURCE_PROFILE_DESCRIPTION_TEXT ) ;
throw new ApplicationProfileNotFoundException (
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
"Your " + SECONDARY_TYPE + " NAME was not found in the generic resource" ) ;
appProf . setDescription ( currValue . get ( 0 ) ) ;
}
currValue = helper . evaluate ( RESOURCE_PROFILE_DESCRIPTION_TEXT ) ;
else logger . warn ( "No Description exists for " + appProf . getName ( ) ) ;
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
appProf . setDescription ( currValue . get ( 0 ) ) ;
currValue = helper . evaluate ( RESOURCE_PROFILE_BODY_APP_ID_TEXT ) ;
} else
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
logger . warn ( "No Description exists for " + appProf . getName ( ) ) ;
appProf . setKey ( currValue . get ( 0 ) ) ;
}
currValue = helper . evaluate ( RESOURCE_PROFILE_BODY_APP_ID_TEXT ) ;
else throw new ApplicationProfileNotFoundException ( "Your applicationProfile ID n was not found in the profile, consider adding <AppId> element in <Body>" ) ;
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
appProf . setKey ( currValue . get ( 0 ) ) ;
currValue = helper . evaluate ( RESOURCE_PROFILE_BODY_THUMBNAIL_URL_TEXT ) ;
} else
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
throw new ApplicationProfileNotFoundException ( "Your " + SECONDARY_TYPE
appProf . setImageUrl ( currValue . get ( 0 ) ) ;
+ " ID was not found in the generic resource, consider adding <AppId> element in <Body>" ) ;
}
else {
currValue = helper . evaluate ( RESOURCE_PROFILE_BODY_THUMBNAIL_URL_TEXT ) ;
logger . warn ( "Null or empty <ThumbnailURL> element in <Body>" + appProf . getName ( ) ) ;
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
}
appProf . setImageUrl ( currValue . get ( 0 ) ) ;
} else {
currValue = helper . evaluate ( "/Resource/Profile/Body/EndPoint[Scope='" + scope . toString ( ) + "']/Scope/text()" ) ;
logger . warn ( "Null or empty <ThumbnailURL> element in <Body> of " + appProf . getName ( ) ) ;
}
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
List < String > scopes = currValue ;
currValue = helper
String currentScope = scopes . get ( 0 ) ;
. evaluate ( "/Resource/Profile/Body/EndPoint[Scope='" + scope . toString ( ) + "']/Scope/text()" ) ;
//int slashCount = StringUtils.countMatches(currentScope, "/");
appProf = readEndPointForScopeWithRetry ( helper , scope , APPLICATION_PROFILE_ITEM . SCOPE , appProf ) ;
boolean isVRE = WsUtil . isVRE ( currentScope ) ;
appProf = readEndPointForScopeWithRetry ( helper , scope , APPLICATION_PROFILE_ITEM . URL , appProf ) ;
//if(slashCount < 3){//CASE not VRE - set session scope
logger . debug ( "returning: " + appProf ) ;
if ( ! isVRE ) { //CASE not VRE - set session scope
logger . info ( "Scope " + scope . toString ( ) + " is not a VRE" ) ;
List < String > listSessionScope = helper . evaluate ( "/Resource/Profile/Body/EndPoint[Scope='" + scope . toString ( ) + "']/Sessionscope/text()" ) ; //get session scope of i+1-mo scope
logger . debug ( "ListSessionScope is: " + listSessionScope . toString ( ) ) ;
if ( listSessionScope ! = null & & listSessionScope . size ( ) > 0 ) { //If sessions scope exists
logger . debug ( "setting session scope " + listSessionScope . get ( 0 ) ) ;
appProf . setScope ( listSessionScope . get ( 0 ) ) ;
}
else {
logger . trace ( "session scope not exists setting scope " + scope . toString ( ) ) ;
appProf . setScope ( scope . toString ( ) ) ;
}
}
else { //CASE IS A VRE
logger . info ( "Scope " + scope . toString ( ) + " is a VRE" ) ;
appProf . setScope ( scope . toString ( ) ) ;
}
//RETRIEVE URL
currValue = helper . evaluate ( "/Resource/Profile/Body/EndPoint[Scope='" + scope . toString ( ) + "']/URL/text()" ) ;
if ( currValue ! = null & & currValue . size ( ) > 0 ) {
String url = currValue . get ( 0 ) ;
// System.out.println("URL "+url);
if ( url ! = null )
appProf . setUrl ( url ) ;
else
throw new ApplicationProfileNotFoundException ( "Your applicationProfile URL was not found in the profile for Scope: " + scope . toString ( ) ) ;
}
else throw new ApplicationProfileNotFoundException ( "Your applicationProfile URL was not found in the profile for Scope: " + scope . toString ( ) ) ;
}
else throw new ApplicationProfileNotFoundException ( "Your applicationProfile with scope " + scope . toString ( ) + " was not found in the profile, consider adding <EndPoint><Scope> element in <Body>" ) ;
logger . debug ( "returning: " + appProf ) ;
return appProf ;
return appProf ;
}
}
} catch ( Exception e ) {
} catch ( Exception e ) {
logger . error ( "Error while trying to fetch applicationProfile profile from the infrastructure" , e ) ;
logger . error ( "Error while trying to fetch applicationProfile profile from the infrastructure" , e ) ;
return null ;
return null ;
} finally {
} finally {
/ *
/ *
if ( originalScope ! = null & & ! originalScope . isEmpty ( ) ) {
* if ( originalScope ! = null & & ! originalScope . isEmpty ( ) ) {
ScopeProvider . instance . set ( originalScope ) ;
* ScopeProvider . instance . set ( originalScope ) ;
logger . info ( "scope provider setted to orginal scope: " + originalScope ) ;
* logger . info ( "scope provider setted to orginal scope: " + originalScope ) ; } else {
} else {
* ScopeProvider . instance . reset ( ) ; logger . info ( "scope provider reset" ) ; }
ScopeProvider . instance . reset ( ) ;
* /
logger . info ( "scope provider reset" ) ;
}
} * /
}
private ApplicationProfile readEndPointForScopeWithRetry ( XPathHelper helper , String scope ,
APPLICATION_PROFILE_ITEM searchItem , ApplicationProfile appProf )
throws ApplicationProfileNotFoundException {
String xPathToQuery = "/Resource/Profile/Body/EndPoint[Scope='" + scope + "']" + searchItem . getXPath ( ) ;
logger . debug ( "Identifying path with current scope: " + xPathToQuery ) ;
List < String > currValue = helper . evaluate ( xPathToQuery ) ;
String queryResult = null ;
if ( currValue = = null | | currValue . isEmpty ( ) ) {
logger . warn ( "In the " + SECONDARY_TYPE + " with name " + appProf . getName ( ) + " the xPath " + xPathToQuery
+ " returned with no results" ) ;
ScopeBean scopeBean = new ScopeBean ( scope ) ;
if ( scopeBean . is ( Type . VRE ) | | scopeBean . is ( Type . VO ) ) {
String pathSeparator = "/" ;
String [ ] components = scope . split ( pathSeparator ) ;
scope = pathSeparator + components [ 1 ] ;
logger . info ( "The scope " + scopeBean . toString ( ) + " is of kind " + Type . VRE + " or " + Type . VO
+ ". Retry in action - going to search the default <EndPoint> with the root scope: " + scope ) ;
xPathToQuery = "/Resource/Profile/Body/EndPoint[Scope='" + scope + "']" + searchItem . getXPath ( ) ;
logger . debug ( "Identifying path with root scope: " + xPathToQuery ) ;
currValue = helper . evaluate ( xPathToQuery ) ;
if ( currValue = = null | | currValue . isEmpty ( ) ) {
logger . warn ( "In the " + SECONDARY_TYPE + " with name " + appProf . getName ( ) + " the xPath " + xPathToQuery
+ " returned with no results" ) ;
}
}
}
}
if ( currValue = = null | | currValue . isEmpty ( ) ) {
throw new ApplicationProfileNotFoundException ( "Your ApplicationProfile in the scope " + scope
+ " have not an <EndPoint> accessible, consider adding <EndPoint><Scope></Scope> element in <Body>" ) ;
}
queryResult = currValue . get ( 0 ) ;
logger . info ( "The xPath: " + xPathToQuery + " returned with the result: " + queryResult ) ;
switch ( searchItem ) {
case SCOPE :
appProf . setScope ( currValue . get ( 0 ) ) ;
break ;
case URL :
appProf . setUrl ( currValue . get ( 0 ) ) ;
break ;
default :
break ;
}
return appProf ;
}
}
/ * *
/ * *
* Gets the gcube generic query string .
* Gets the gcube generic xPath string .
*
*
* @param secondaryType the secondary type
* @param secondaryType the secondary type
* @param appId the app id
* @param appId the app id
* @return the gcube generic query string
* @return the gcube generic xPath string
* /
* /
public static String getGcubeGenericQueryString ( String secondaryType , String appId ) {
public static String getGcubeGenericQueryString ( String secondaryType , String appId ) {
return "for $profile in collection('/db/Profiles/GenericResource')//Resource " +
return "for $profile in collection('/db/Profiles/GenericResource')//Resource "
"where $profile/Profile/SecondaryType/string() eq '" + secondaryType + "' and $profile/Profile/Body/AppId/string() " +
+ "where $profile/Profile/SecondaryType/string() eq '" + secondaryType
" eq '" + appId + "'" +
+ "' and $profile/Profile/Body/AppId/string() " + " eq '" + appId + "'" + "return $profile" ;
"return $profile" ;
}
}
/ * *
/ * *
@ -219,7 +250,6 @@ public class ApplicationProfileReader {
return secondaryType ;
return secondaryType ;
}
}
/ * *
/ * *
* Gets the scope .
* Gets the scope .
*
*
@ -238,8 +268,9 @@ public class ApplicationProfileReader {
return resourceName ;
return resourceName ;
}
}
/ *
/ * ( non - Javadoc )
* ( non - Javadoc )
*
* @see java . lang . Object # toString ( )
* @see java . lang . Object # toString ( )
* /
* /
@Override
@Override
