net.exogeni.orca.ndl

Class NdlToRSpecHelper

java.lang.Object

net.exogeni.orca.ndl.NdlToRSpecHelper

public class NdlToRSpecHelper
extends java.lang.Object

A few helper functions to go from NDL to RSpec

Author:

ibaldin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NdlToRSpecHelper.UrnType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CM_URN_PATTERN
static java.lang.String	COMPONENT_URN_GLOBAL_PATTERN
static java.lang.String	COMPONENT_URN_PATTERN
static java.lang.String	CONTROLLER_URL_PATTERN
static java.lang.String	SLIVER_URN_PATTERN
static java.lang.String	UNKNOWN_CM_URN
static java.lang.String	UNKNOWN_COMPONENT_URN
static java.lang.String	UNKNOWN_SLIVER_URN

Constructor Summary

Constructors

Constructor and Description
NdlToRSpecHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	cidUrnFromUrl(java.lang.String domainUrl, NdlToRSpecHelper.UrnType type, java.lang.String name) Generate a component id from a URL and a domain URL
static java.lang.String	cidUrnFromUrl(java.lang.String domainUrl, NdlToRSpecHelper.UrnType type, java.lang.String name1, java.lang.String name2) Generate a component id from a URL and a domain URL and concatenation of names
static java.lang.String	cmFromDomain(java.lang.String domainUrl) Get a urn for CM from a domain URL like so: domainUrl = http://geni-orca.renci.org/owl/rcivmsite.rdf#rcivmsite/Domain cmUrn = urn:publicid:IDN+rcivmsite+authority+cm
static boolean	domainNameSpaceCheck(java.lang.String urn, java.util.Set<java.lang.String> dom) Check that the domain matches what is expected (e.g.
static java.lang.String	domToString(org.w3c.dom.Node n, boolean withNS, boolean withHeader) Turn a DOM node into string, with or without namespace declarations, with or without xml header
static java.lang.String	generateDomainName(java.lang.String urn) Based on urn that has exogeni.net:xxxsite, generate NDL domain xxxsite.rdf#xxxsite
static java.lang.String	generateDomainNameSpace(java.lang.String urn) Generate a domain name space according to convention
static java.lang.String	generateSiteName(java.lang.String urn) generate a site name from domain name URN
static java.lang.String	getClientId(com.hp.hpl.jena.rdf.model.Resource r) ORCA equivalent of client id comes in the form of GUID#client id so get the client id from that
static java.lang.String	getClientId(java.lang.String s) Sometimes we only have a string (not the resource) containing the client id as above
static java.lang.String	getControllerForSite(java.lang.String domainUrl) Guess controller URL from domain name
static java.lang.String	getControllerForUrl(java.lang.String url)
static java.lang.String	getTrueName(com.hp.hpl.jena.rdf.model.Resource r) sometimes getLocalName is not good enough so we strip off orca name space and call it a day
static java.lang.String	getTrueName(java.lang.String r) Equivalent to getTrueName(r.getURI());
static java.lang.String	idFromDomain(java.lang.String domainUrl) Similar to cmFromDomain, except generates ids (e.g.
static java.lang.String	interfaceUrlFromURN(java.lang.String urn) Convert a interfacer urn into a proper URL.
static void	main(java.lang.String[] args)
static org.w3c.dom.NodeList	parseXmlToDOM(java.lang.String s) Parse a string into a DOM and return a NodeList
static java.lang.String	sliverUrlFromURN(java.lang.String urn) Convert a sliver urn into a proper URL.
static java.lang.String	sliverUrnFromRack(java.lang.String sid, java.lang.String rack) Get sliver URN from sliver name and rack id
static boolean	specificDomainCheck(java.lang.String urn, java.lang.String against) Check if there is a specific domain in the urn
static java.lang.String	stripXmlHead(java.lang.String s) Strip <? ?> header from XML string
static java.lang.String	stripXmlNs(java.lang.String s) Strip namespace declarations from XML string

Methods inherited from class java.lang.Object

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

Field Detail

CM_URN_PATTERN

public static java.lang.String CM_URN_PATTERN

CONTROLLER_URL_PATTERN

public static java.lang.String CONTROLLER_URL_PATTERN

COMPONENT_URN_PATTERN

public static java.lang.String COMPONENT_URN_PATTERN

SLIVER_URN_PATTERN

public static java.lang.String SLIVER_URN_PATTERN

COMPONENT_URN_GLOBAL_PATTERN

public static java.lang.String COMPONENT_URN_GLOBAL_PATTERN

UNKNOWN_COMPONENT_URN

public static java.lang.String UNKNOWN_COMPONENT_URN

UNKNOWN_CM_URN

public static java.lang.String UNKNOWN_CM_URN

UNKNOWN_SLIVER_URN

public static java.lang.String UNKNOWN_SLIVER_URN

Constructor Detail

NdlToRSpecHelper

public NdlToRSpecHelper()

Method Detail

getControllerForUrl

public static java.lang.String getControllerForUrl(java.lang.String url)

getControllerForSite

public static java.lang.String getControllerForSite(java.lang.String domainUrl)

Guess controller URL from domain name

Parameters:

domainUrl - domainUrl

Returns:

String

cmFromDomain

public static java.lang.String cmFromDomain(java.lang.String domainUrl)

Get a urn for CM from a domain URL like so: domainUrl = http://geni-orca.renci.org/owl/rcivmsite.rdf#rcivmsite/Domain cmUrn = urn:publicid:IDN+rcivmsite+authority+cm

Parameters:

domainUrl - domainUrl

Returns:

String

idFromDomain

public static java.lang.String idFromDomain(java.lang.String domainUrl)

Similar to cmFromDomain, except generates ids (e.g. for stitching extension)

Parameters:

domainUrl - domainUrl

Returns:

String

cidUrnFromUrl

public static java.lang.String cidUrnFromUrl(java.lang.String domainUrl,
                                             NdlToRSpecHelper.UrnType type,
                                             java.lang.String name)

Generate a component id from a URL and a domain URL

Parameters:

domainUrl - domainUrl

type - - [node, link, interface]

name - - unique name

Returns:

String

cidUrnFromUrl

public static java.lang.String cidUrnFromUrl(java.lang.String domainUrl,
                                             NdlToRSpecHelper.UrnType type,
                                             java.lang.String name1,
                                             java.lang.String name2)

Generate a component id from a URL and a domain URL and concatenation of names

Parameters:

domainUrl - domainUrl

type - - [node, link, interface]

name1 - - unique name

name2 - - unique name

Returns:

String

specificDomainCheck

public static boolean specificDomainCheck(java.lang.String urn,
                                          java.lang.String against)

Check if there is a specific domain in the urn

Parameters:

urn - urn

against - against

Returns:

true or false

domainNameSpaceCheck

public static boolean domainNameSpaceCheck(java.lang.String urn,
                                           java.util.Set<java.lang.String> dom)

Check that the domain matches what is expected (e.g. dom=exogeni.net)

Parameters:

urn - urn

dom - dom

Returns:

true or false

generateDomainNameSpace

public static java.lang.String generateDomainNameSpace(java.lang.String urn)

Generate a domain name space according to convention

Parameters:

urn - urn

Returns:

String

generateSiteName

public static java.lang.String generateSiteName(java.lang.String urn)

generate a site name from domain name URN

Parameters:

urn - urn

Returns:

String

generateDomainName

public static java.lang.String generateDomainName(java.lang.String urn)

Based on urn that has exogeni.net:xxxsite, generate NDL domain xxxsite.rdf#xxxsite

Parameters:

urn - urn

Returns:

String

sliverUrnFromRack

public static java.lang.String sliverUrnFromRack(java.lang.String sid,
                                                 java.lang.String rack)

Get sliver URN from sliver name and rack id

Parameters:

sid - - sliver name

rack - - exogeni.net:rcivmsite

Returns:

String

sliverUrlFromURN

public static java.lang.String sliverUrlFromURN(java.lang.String urn)

Convert a sliver urn into a proper URL.

Parameters:

urn - urn

Returns:

String

interfaceUrlFromURN

public static java.lang.String interfaceUrlFromURN(java.lang.String urn)

Convert a interfacer urn into a proper URL.

Parameters:

urn - urn

Returns:

String

getTrueName

public static java.lang.String getTrueName(com.hp.hpl.jena.rdf.model.Resource r)

sometimes getLocalName is not good enough so we strip off orca name space and call it a day

Parameters:

r - r

Returns:

String

getTrueName

public static java.lang.String getTrueName(java.lang.String r)

Equivalent to getTrueName(r.getURI());

Parameters:

r - r

Returns:

String

getClientId

public static java.lang.String getClientId(com.hp.hpl.jena.rdf.model.Resource r)

ORCA equivalent of client id comes in the form of GUID#client id so get the client id from that

Parameters:

r - r

Returns:

String

getClientId

public static java.lang.String getClientId(java.lang.String s)

Sometimes we only have a string (not the resource) containing the client id as above

Parameters:

s - s

Returns:

String

domToString

public static java.lang.String domToString(org.w3c.dom.Node n,
                                           boolean withNS,
                                           boolean withHeader)
                                    throws java.lang.Exception

Turn a DOM node into string, with or without namespace declarations, with or without xml header

Parameters:

n - n

withNS - withNs

withHeader - withHeader

Returns:

String

Throws:

java.lang.Exception - in case of error

stripXmlHead

public static java.lang.String stripXmlHead(java.lang.String s)

Strip <? ?> header from XML string

Parameters:

s - s

Returns:

String

stripXmlNs

public static java.lang.String stripXmlNs(java.lang.String s)

Strip namespace declarations from XML string

Parameters:

s - s

Returns:

String

parseXmlToDOM

public static org.w3c.dom.NodeList parseXmlToDOM(java.lang.String s)

Parse a string into a DOM and return a NodeList

Parameters:

s - s

Returns:

node list

main

public static void main(java.lang.String[] args)