net.exogeni.orca.ndl

Class NdlGenerator

java.lang.Object

net.exogeni.orca.ndl.NdlGenerator

public class NdlGenerator
extends java.lang.Object

This class generates NDL

Author:

ibaldin

Field Summary

Fields

Modifier and Type	Field and Description
protected com.hp.hpl.jena.ontology.OntModel	blank
static java.util.Set<java.lang.String>	externalSchemas
protected java.lang.String	requestId

Constructor Summary

Constructors

Constructor and Description
NdlGenerator(org.apache.log4j.Logger log)
NdlGenerator(NdlModifyParser p, org.apache.log4j.Logger log) Build a generator based on pre-existing modify model in the parser
NdlGenerator(NdlRequestParser p, org.apache.log4j.Logger log) Build a generator based on pre-existing request model in the parser.
NdlGenerator(java.lang.String guid, org.apache.log4j.Logger log)
NdlGenerator(java.lang.String guid, org.apache.log4j.Logger log, boolean modify) if modify set to true, initializes a modify request

Method Summary

Modifier and Type	Method and Description
com.hp.hpl.jena.ontology.Individual	addBandwidthToConnection(com.hp.hpl.jena.ontology.Individual conn, java.lang.Long bandwidth) declare a network connection w/o layer
void	addBareMetalDomainProperty(com.hp.hpl.jena.ontology.Individual cluster)
void	addBeginningToTerm(com.hp.hpl.jena.ontology.Individual begI, com.hp.hpl.jena.ontology.Individual termI)
com.hp.hpl.jena.ontology.Individual	addBlobOnColor__(com.hp.hpl.jena.ontology.Individual color, java.lang.String blob, boolean isXML, java.lang.String xmlns) Use compression instead of xml literal to get around Jena bugs for XML literals
com.hp.hpl.jena.ontology.Individual	addBlobOnColor(com.hp.hpl.jena.ontology.Individual color, java.lang.String blob, boolean isXML) Add text blob to color
com.hp.hpl.jena.ontology.Individual	addColorToIndividual(com.hp.hpl.jena.ontology.Individual ne, com.hp.hpl.jena.ontology.Individual color)
void	addDependOnToIndividual(com.hp.hpl.jena.ontology.Individual dependency, com.hp.hpl.jena.ontology.Individual ind) Add dependency to an individual (both should be NetworkElement subclasses)
void	addDiskImageToIndividual(com.hp.hpl.jena.ontology.Individual diskImage, com.hp.hpl.jena.ontology.Individual resI) Add DiskImage to reservation or node
void	addDomainToIndividual(com.hp.hpl.jena.ontology.Individual dom, com.hp.hpl.jena.ontology.Individual ind) Add 'inDomain' property to individual
void	addDurationToTerm(com.hp.hpl.jena.ontology.Individual durI, com.hp.hpl.jena.ontology.Individual termI)
void	addEndToTerm(com.hp.hpl.jena.ontology.Individual endI, com.hp.hpl.jena.ontology.Individual termI)
com.hp.hpl.jena.ontology.Individual	addEthernetAdaptation(com.hp.hpl.jena.ontology.Individual intf, com.hp.hpl.jena.ontology.Individual adaptTo) Add ethernet adaptation to another interface
void	addFourtyGBareMetalDomainProperty(com.hp.hpl.jena.ontology.Individual cluster)
void	addGuid(com.hp.hpl.jena.ontology.Individual in, java.lang.String guid) Add addGuid property to this individual
void	addInterfaceToIndividual(com.hp.hpl.jena.ontology.Individual iface, com.hp.hpl.jena.ontology.Individual ind) add interface to e.g.
com.hp.hpl.jena.ontology.Individual	addIPToIndividual(java.lang.String ip, com.hp.hpl.jena.ontology.Individual ind) add IP address to individual e.g.
void	addKeysOnColor(com.hp.hpl.jena.ontology.Individual color, java.util.Map<java.lang.String,java.lang.String> keys) add keys to color
void	addLabelToIndividual(com.hp.hpl.jena.ontology.Individual c, java.lang.String label) Add a layer:Label to an individual (e.g.
com.hp.hpl.jena.ontology.Individual	addLayerToConnection(com.hp.hpl.jena.ontology.Individual conn, java.lang.String prefix, java.lang.String layer) declare a network point-to-point connection at specific layer
void	addNameToInterface(java.lang.String interfaceName, com.hp.hpl.jena.ontology.Individual intf) add hostinterface name literal to interface
void	addNetmaskToIP(com.hp.hpl.jena.ontology.Individual ip, java.lang.String netmask) Add netmask to an individual IP subject (the subject must have been added using addIPToIndividual or addUniqueIPToIndividual
void	addNodeToDomain(com.hp.hpl.jena.ontology.Individual dom, com.hp.hpl.jena.ontology.Individual node) Bind node to domain
void	addNodeTypeToCE(java.lang.String ns, java.lang.String tp, com.hp.hpl.jena.ontology.Individual node) Add node type from particular namespace to node
void	addNumCEsToCluster(java.lang.Integer ns, com.hp.hpl.jena.ontology.Individual cluster) Add number of compute elements to cluster
void	addOfPropertiesToSlice(java.lang.String userEmail, java.lang.String slicePass, java.lang.String userCtrl, com.hp.hpl.jena.ontology.Individual slice) Add OpenFlow-relevant properties to a slice individual
void	addOpenFlowCapable(com.hp.hpl.jena.ontology.Individual res, java.lang.String version) Make individual openflow capable (with version 1.0, 1.1 or 1.2)
void	addPortToProxy(java.lang.String port, com.hp.hpl.jena.ontology.Individual prx) Add a port to be proxied to a proxy (no information how it will be proxied)
void	addPortToProxy(java.lang.String port, java.lang.String newPort, java.lang.String newIp, com.hp.hpl.jena.ontology.Individual prx) Add a port with proxy information about it (new port and new IP address)
void	addPostBootScriptToCE(java.lang.String pbscript, com.hp.hpl.jena.ontology.Individual node) Add a post boot script string to a node
void	addPropertiesToStorage(long capacity, java.lang.String fstype, java.lang.String fsparam, java.lang.String fsmntpoint, boolean doFormat, com.hp.hpl.jena.ontology.Individual in) Add properties to storage node
void	addProxyToIndividual(com.hp.hpl.jena.ontology.Individual proxy, com.hp.hpl.jena.ontology.Individual resI) Add a proxy to (most likely node)
void	addRDFSLabelToIndividual(com.hp.hpl.jena.ontology.Individual c, java.lang.String label) Add a literal rdfs:label to something
void	addResourceToReservation(com.hp.hpl.jena.ontology.Individual resI, com.hp.hpl.jena.ontology.Individual toAdd) add a resource to the reservation
com.hp.hpl.jena.rdf.model.Resource	addSimpleProperty(com.hp.hpl.jena.ontology.Individual i, java.lang.String prefix, java.lang.String pName, java.lang.String val) Add simple literal property
void	addSliceToReservation(com.hp.hpl.jena.ontology.Individual resI, com.hp.hpl.jena.ontology.Individual sl) Add a sub-slice to reservation
void	addTermToReservation(com.hp.hpl.jena.ontology.Individual termI, com.hp.hpl.jena.ontology.Individual resI) Add a term to a reservation
com.hp.hpl.jena.rdf.model.Resource	addTypedProperty(com.hp.hpl.jena.ontology.Individual i, java.lang.String prefix, java.lang.String pName, java.lang.String val, com.hp.hpl.jena.datatypes.RDFDatatype type) add typed property to an individual
com.hp.hpl.jena.ontology.Individual	addUniqueIPToIndividual(java.lang.String ip, java.lang.String name, com.hp.hpl.jena.ontology.Individual ind) Add a unique IP individual using e.g.
void	addURNToIndividual(com.hp.hpl.jena.ontology.Individual ind, java.lang.String urn) Add a URN to individual (hasURN)
void	addUserDNProperty(java.lang.String dn, com.hp.hpl.jena.ontology.Individual i)
void	addVMDomainProperty(com.hp.hpl.jena.ontology.Individual cluster) Add a VM domain resource property (for Euca clusters)
com.hp.hpl.jena.ontology.Individual	declareBroadcastConnection(java.lang.String name) Declare a broadcast connection.
com.hp.hpl.jena.ontology.Individual	declareColor(java.lang.String label, java.util.Map<java.lang.String,java.lang.String> keys, java.lang.String blob, boolean isXML) Declare a new color individual
com.hp.hpl.jena.ontology.Individual	declareComputeElement(java.lang.String name) declare a ComputeElement in the request model
com.hp.hpl.jena.ontology.Individual	declareDiskImage(java.lang.String url, java.lang.String guid) declare a disk image
com.hp.hpl.jena.ontology.Individual	declareDiskImage(java.lang.String url, java.lang.String guid, java.lang.String shortName) Declare an image with a short name
com.hp.hpl.jena.ontology.Individual	declareDomain(java.lang.String name) declare a domain site (appends /Domain to name as per convention; declares it in the general http://geni-orca.renci.org/owl prefix, not request prefix)
com.hp.hpl.jena.ontology.Individual	declareExistingInterface(java.lang.String url) Declare an existing interface for e.g.
com.hp.hpl.jena.ontology.Individual	declareInterface(java.lang.String name) declare an interface in the request model
com.hp.hpl.jena.ontology.Individual	declareISCSIStorageNode(java.lang.String name) Declare storage node without parameters
com.hp.hpl.jena.ontology.Individual	declareISCSIStorageNode(java.lang.String name, long capacity, java.lang.String fstype, java.lang.String fsparam, java.lang.String fsmntpoint, boolean doFormat) Declare an ISCSI storage node
com.hp.hpl.jena.ontology.Individual	declareModifiedBroadcastConnection(java.lang.String url) Declare a broadcast connection that already exists and will be modified
com.hp.hpl.jena.ontology.Individual	declareModifiedComputeElement(java.lang.String url, java.lang.String guid) Declare a ComputeElement with existing url (from manifest) that will be modified.
com.hp.hpl.jena.ontology.Individual	declareModifyElementAddElement(com.hp.hpl.jena.ontology.Individual mresI, com.hp.hpl.jena.ontology.Individual el) Declare an element of a modify reservation that adds a single element (node or link)
com.hp.hpl.jena.ontology.Individual	declareModifyElementModifyNode(com.hp.hpl.jena.ontology.Individual mresI, com.hp.hpl.jena.ontology.Individual node) Declare an element to modify an existing node (add interface)
com.hp.hpl.jena.ontology.Individual	declareModifyElementNGDeleteNode(com.hp.hpl.jena.ontology.Individual mresI, java.lang.String ngUrl, java.lang.String nodeUrl) Declare an element of a modify reservation that deletes a node from a node group
com.hp.hpl.jena.ontology.Individual	declareModifyElementNGIncreaseBy(com.hp.hpl.jena.ontology.Individual mresI, java.lang.String ngUrl, java.lang.Integer count) Declare an element of a modify reservation that increases node count in a node group.
com.hp.hpl.jena.ontology.Individual	declareModifyElementRemoveElement(com.hp.hpl.jena.ontology.Individual mresI, com.hp.hpl.jena.ontology.Individual el) Declare an element of a modify reservation that deletes a single element individual
com.hp.hpl.jena.ontology.Individual	declareModifyElementRemoveLink(com.hp.hpl.jena.ontology.Individual mresI, java.lang.String elUrl, java.lang.String guid) Declare an element of a modify reservation that deletes a single link
com.hp.hpl.jena.ontology.Individual	declareModifyElementRemoveNode(com.hp.hpl.jena.ontology.Individual mresI, java.lang.String elUrl, java.lang.String guid) Declare an element of a modify reservation that deletes a single node
com.hp.hpl.jena.ontology.Individual	declareModifyReservation(java.lang.String name) Declare a modify reservation with this name
com.hp.hpl.jena.ontology.Individual	declareNetworkConnection(java.lang.String name) some connections don't declare bandwidth.
com.hp.hpl.jena.ontology.Individual	declareOfController(java.lang.String name, java.lang.String url) Declare an openflow controller with this URL
com.hp.hpl.jena.ontology.Individual	declareOfSlice(java.lang.String sname) Declare an openflow slice
com.hp.hpl.jena.ontology.Individual	declareReservation() Declare an empty reservation
com.hp.hpl.jena.ontology.Individual	declareReservation(java.util.Date start, java.util.Date end) Declare Reservation individual with start and end date
com.hp.hpl.jena.ontology.Individual	declareReservation(java.util.Date start, long dur, int units) Declare a reservation with a start time and duration
com.hp.hpl.jena.ontology.Individual	declareServerCloud(java.lang.String name) declare an unsplittable (by default) ServerCloud in the request model
com.hp.hpl.jena.ontology.Individual	declareServerCloud(java.lang.String name, boolean splittable) declare a ServerCloud in the request model (with splittable property)
com.hp.hpl.jena.ontology.Individual	declareSlice(java.lang.String sname) Declare a slice with a name
com.hp.hpl.jena.ontology.Individual	declareStitchingNode(java.lang.String name) declare a stitching node
com.hp.hpl.jena.ontology.Individual	declareStitchportInterface(java.lang.String url, java.lang.String label) Declare a unique stitchport interface based on URL and label with TaggedEthernet adaptation and a label
com.hp.hpl.jena.ontology.Individual	declareTCPProxy(java.lang.String suffix) Declare a TCP proxy
com.hp.hpl.jena.ontology.Individual	declareTerm() Declare a term from now using duration, units comes from java.util.Calandar
com.hp.hpl.jena.ontology.Individual	declareTermBeginning(java.util.Date date) Declare beginning of a term
com.hp.hpl.jena.ontology.Individual	declareTermDuration(long dur, int units) Declare term duration in units from java.util.Calendar
com.hp.hpl.jena.ontology.Individual	declareTermDuration(long d, long hr, long min) declare term duration of days, hrs and minutes (can be 0)
com.hp.hpl.jena.ontology.Individual	declareTermEnd(java.util.Date date) Declare term end
protected com.hp.hpl.jena.ontology.Individual	doModifyElement(com.hp.hpl.jena.ontology.Individual mresI, com.hp.hpl.jena.ontology.Individual el, java.lang.String modifyAction)
void	done() Remove the model and the reference model.
void	encodeColorDependency(com.hp.hpl.jena.ontology.Individual from, com.hp.hpl.jena.ontology.Individual to, com.hp.hpl.jena.ontology.Individual color) Encode a color dependency between two network elements
protected void	finalize()
java.lang.String	getGVOutput() Produce Graphviz output for visualization
com.hp.hpl.jena.ontology.Individual	getNonrequestIndividual(java.lang.String name) get an individual that is not part of request namespace
com.hp.hpl.jena.ontology.Individual	getRequestIndividual(java.lang.String name) try to get individual with this name from the request
com.hp.hpl.jena.ontology.OntModel	getWorkingModel() Get the working model
static void	main(java.lang.String[] argv)
void	removeInterfaceFromIndividual(java.lang.String iface, com.hp.hpl.jena.ontology.Individual ind) Remove a previously linked interface from individual
void	removeNodeTypeFromCE(com.hp.hpl.jena.ontology.Individual node) Removes ALL node types from particular node individual
void	removeNodeTypeFromCE(java.lang.String ns, java.lang.String tp, com.hp.hpl.jena.ontology.Individual node) Remove specific node type from node individual
void	setInterfaceIP(java.lang.String ip, com.hp.hpl.jena.ontology.Individual intf) Set IP on interface individual, including overwriting any existing IP (but not netmask).
void	setInterfaceNetmask(java.lang.String nm, com.hp.hpl.jena.ontology.Individual intf) Set netmask on interface, including overwriting any existing netmask (but not IP).
java.lang.String	toN3String() produce N3 output of the model
java.lang.String	toString()
java.lang.String	toXMLString() produce RDF-XML output of the model

Methods inherited from class java.lang.Object

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

Field Detail

externalSchemas

public static final java.util.Set<java.lang.String> externalSchemas

blank

protected com.hp.hpl.jena.ontology.OntModel blank

requestId

protected java.lang.String requestId

Constructor Detail

NdlGenerator

public NdlGenerator(org.apache.log4j.Logger log)

NdlGenerator

public NdlGenerator(java.lang.String guid,
                    org.apache.log4j.Logger log)

NdlGenerator

public NdlGenerator(java.lang.String guid,
                    org.apache.log4j.Logger log,
                    boolean modify)

if modify set to true, initializes a modify request

Parameters:

guid - guid

log - log

modify - modify

NdlGenerator

public NdlGenerator(NdlRequestParser p,
                    org.apache.log4j.Logger log)
             throws NdlException

Build a generator based on pre-existing request model in the parser.

Parameters:

p - p

log - log

Throws:

NdlException - in case of error

NdlGenerator

public NdlGenerator(NdlModifyParser p,
                    org.apache.log4j.Logger log)
             throws NdlException

Build a generator based on pre-existing modify model in the parser

Parameters:

p - p

log - log

Throws:

NdlException - in case of error

Method Detail

done

public void done()

Remove the model and the reference model. Making calls on NdlGenerator after calling done() will result in NPEs

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

getWorkingModel

public com.hp.hpl.jena.ontology.OntModel getWorkingModel()

Get the working model

Returns:

OntModel

addTypedProperty

public com.hp.hpl.jena.rdf.model.Resource addTypedProperty(com.hp.hpl.jena.ontology.Individual i,
                                                           java.lang.String prefix,
                                                           java.lang.String pName,
                                                           java.lang.String val,
                                                           com.hp.hpl.jena.datatypes.RDFDatatype type)
                                                    throws NdlException

add typed property to an individual

Parameters:

i - i

prefix - prefix

pName - pName

val - val

type - type

Returns:

Resource

Throws:

NdlException - in case of error

addSimpleProperty

public com.hp.hpl.jena.rdf.model.Resource addSimpleProperty(com.hp.hpl.jena.ontology.Individual i,
                                                            java.lang.String prefix,
                                                            java.lang.String pName,
                                                            java.lang.String val)
                                                     throws NdlException

Add simple literal property

Parameters:

i - i

prefix - prefix

pName - pName

val - val

Returns:

Resource

Throws:

NdlException - in case of error

declareComputeElement

public com.hp.hpl.jena.ontology.Individual declareComputeElement(java.lang.String name)
                                                          throws NdlException

declare a ComputeElement in the request model

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareModifiedComputeElement

public com.hp.hpl.jena.ontology.Individual declareModifiedComputeElement(java.lang.String url,
                                                                         java.lang.String guid)
                                                                  throws NdlException

Declare a ComputeElement with existing url (from manifest) that will be modified. Modifies always require a guid.

Parameters:

url - url

guid - guid (can be null)

Returns:

Individual

Throws:

NdlException - in case of error

declareStitchingNode

public com.hp.hpl.jena.ontology.Individual declareStitchingNode(java.lang.String name)
                                                         throws NdlException

declare a stitching node

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareISCSIStorageNode

public com.hp.hpl.jena.ontology.Individual declareISCSIStorageNode(java.lang.String name)
                                                            throws NdlException

Declare storage node without parameters

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareISCSIStorageNode

public com.hp.hpl.jena.ontology.Individual declareISCSIStorageNode(java.lang.String name,
                                                                   long capacity,
                                                                   java.lang.String fstype,
                                                                   java.lang.String fsparam,
                                                                   java.lang.String fsmntpoint,
                                                                   boolean doFormat)
                                                            throws NdlException

Declare an ISCSI storage node

Parameters:

name - name

capacity - capacity

fstype - - can be null

fsparam - - can be null

fsmntpoint - point - can be null

doFormat - doFormat

Returns:

Individual

Throws:

NdlException - in case of error

declareServerCloud

public com.hp.hpl.jena.ontology.Individual declareServerCloud(java.lang.String name,
                                                              boolean splittable)
                                                       throws NdlException

declare a ServerCloud in the request model (with splittable property)

Parameters:

name - name

splittable - splittable

Returns:

Individual

Throws:

NdlException - in case of error

declareServerCloud

public com.hp.hpl.jena.ontology.Individual declareServerCloud(java.lang.String name)
                                                       throws NdlException

declare an unsplittable (by default) ServerCloud in the request model

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareInterface

public com.hp.hpl.jena.ontology.Individual declareInterface(java.lang.String name)
                                                     throws NdlException

declare an interface in the request model

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareExistingInterface

public com.hp.hpl.jena.ontology.Individual declareExistingInterface(java.lang.String url)
                                                             throws NdlException

Declare an existing interface for e.g. stitching (not in request namespace)

Parameters:

url - url

Returns:

Individual

Throws:

NdlException - in case of error

declareStitchportInterface

public com.hp.hpl.jena.ontology.Individual declareStitchportInterface(java.lang.String url,
                                                                      java.lang.String label)
                                                               throws NdlException

Declare a unique stitchport interface based on URL and label with TaggedEthernet adaptation and a label

Parameters:

url - url

label - label

Returns:

Individual

Throws:

NdlException - in case of error

declareDiskImage

public com.hp.hpl.jena.ontology.Individual declareDiskImage(java.lang.String url,
                                                            java.lang.String guid)
                                                     throws NdlException

declare a disk image

Parameters:

url - url

guid - guid

Returns:

Individual

Throws:

NdlException - in case of error

declareDiskImage

public com.hp.hpl.jena.ontology.Individual declareDiskImage(java.lang.String url,
                                                            java.lang.String guid,
                                                            java.lang.String shortName)
                                                     throws NdlException

Declare an image with a short name

Parameters:

url - url

guid - guid

shortName - shortName

Returns:

Individual

Throws:

NdlException - in case of error

addLayerToConnection

public com.hp.hpl.jena.ontology.Individual addLayerToConnection(com.hp.hpl.jena.ontology.Individual conn,
                                                                java.lang.String prefix,
                                                                java.lang.String layer)
                                                         throws NdlException

declare a network point-to-point connection at specific layer

Parameters:

conn - conn

prefix - prefix

layer - layer

Returns:

Individual

Throws:

NdlException - in case of error

addBandwidthToConnection

public com.hp.hpl.jena.ontology.Individual addBandwidthToConnection(com.hp.hpl.jena.ontology.Individual conn,
                                                                    java.lang.Long bandwidth)
                                                             throws NdlException

declare a network connection w/o layer

Parameters:

conn - conn

bandwidth - bandwidth

Returns:

Individual

Throws:

NdlException - in case of error

declareNetworkConnection

public com.hp.hpl.jena.ontology.Individual declareNetworkConnection(java.lang.String name)
                                                             throws NdlException

some connections don't declare bandwidth. you can add label or bandwidth to it.

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareBroadcastConnection

public com.hp.hpl.jena.ontology.Individual declareBroadcastConnection(java.lang.String name)
                                                               throws NdlException

Declare a broadcast connection. You can add label or bandwidth to it

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareModifiedBroadcastConnection

public com.hp.hpl.jena.ontology.Individual declareModifiedBroadcastConnection(java.lang.String url)
                                                                       throws NdlException

Declare a broadcast connection that already exists and will be modified

Parameters:

url - url

Returns:

Individual

Throws:

NdlException - in case of error

addLabelToIndividual

public void addLabelToIndividual(com.hp.hpl.jena.ontology.Individual c,
                                 java.lang.String label)
                          throws NdlException

Add a layer:Label to an individual (e.g. VLAN tag to connection)

Parameters:

c - c

label - label

Throws:

NdlException - in case of error

addRDFSLabelToIndividual

public void addRDFSLabelToIndividual(com.hp.hpl.jena.ontology.Individual c,
                                     java.lang.String label)
                              throws NdlException

Add a literal rdfs:label to something

Parameters:

c - c

label - label

Throws:

NdlException - in case of error

addInterfaceToIndividual

public void addInterfaceToIndividual(com.hp.hpl.jena.ontology.Individual iface,
                                     com.hp.hpl.jena.ontology.Individual ind)
                              throws NdlException

add interface to e.g. server or connection

Parameters:

iface - iface

ind - ind

Throws:

NdlException - in case of error

removeInterfaceFromIndividual

public void removeInterfaceFromIndividual(java.lang.String iface,
                                          com.hp.hpl.jena.ontology.Individual ind)
                                   throws NdlException

Remove a previously linked interface from individual

Parameters:

iface - iface

ind - ind

Throws:

NdlException - in case of error

addIPToIndividual

public com.hp.hpl.jena.ontology.Individual addIPToIndividual(java.lang.String ip,
                                                             com.hp.hpl.jena.ontology.Individual ind)
                                                      throws NdlException

add IP address to individual e.g. Interface. Note that adding the same IP will result in re-using a previously created individual, so if a model needs to contain multiple definitions of similar IP addresses, use addUniqueIPIndividual() instead. It disassociates previously created IP individual from the interface.

Parameters:

ip - ip

ind - ind

Returns:

Individual

Throws:

NdlException - in case of error

addUniqueIPToIndividual

public com.hp.hpl.jena.ontology.Individual addUniqueIPToIndividual(java.lang.String ip,
                                                                   java.lang.String name,
                                                                   com.hp.hpl.jena.ontology.Individual ind)
                                                            throws NdlException

Add a unique IP individual using e.g. VLAN name. Also see addIPIndividual(). It disassociates previously created IP individual from the interface.

Parameters:

ip - - ip address string

name - - e.g. vlan name

ind - ind

Returns:

Individual

Throws:

NdlException - in case of error

addNetmaskToIP

public void addNetmaskToIP(com.hp.hpl.jena.ontology.Individual ip,
                           java.lang.String netmask)
                    throws NdlException

Add netmask to an individual IP subject (the subject must have been added using addIPToIndividual or addUniqueIPToIndividual

Parameters:

ip - ip

netmask - netmask

Throws:

NdlException - in case of error

setInterfaceIP

public void setInterfaceIP(java.lang.String ip,
                           com.hp.hpl.jena.ontology.Individual intf)
                    throws NdlException

Set IP on interface individual, including overwriting any existing IP (but not netmask). This function is complimentary to the addIPToIndividual() and can undo its results.

Parameters:

ip - ip

intf - intf

Throws:

NdlException - in case of error

setInterfaceNetmask

public void setInterfaceNetmask(java.lang.String nm,
                                com.hp.hpl.jena.ontology.Individual intf)
                         throws NdlException

Set netmask on interface, including overwriting any existing netmask (but not IP). This function is complimentary to addNetmaskToIP() and can undo its results.

Parameters:

nm - nm

intf - intf

Throws:

NdlException - in case of error

addNameToInterface

public void addNameToInterface(java.lang.String interfaceName,
                               com.hp.hpl.jena.ontology.Individual intf)
                        throws NdlException

add hostinterface name literal to interface

Parameters:

interfaceName - interfaceName

intf - intf

Throws:

NdlException - in case of error

addPropertiesToStorage

public void addPropertiesToStorage(long capacity,
                                   java.lang.String fstype,
                                   java.lang.String fsparam,
                                   java.lang.String fsmntpoint,
                                   boolean doFormat,
                                   com.hp.hpl.jena.ontology.Individual in)
                            throws NdlException

Add properties to storage node

Parameters:

capacity - capacity

fstype - fstype

fsparam - fsparam

fsmntpoint - fsmntpoint

doFormat - doFormat

in - individual to add properties to

Throws:

NdlException - in case of error

addURNToIndividual

public void addURNToIndividual(com.hp.hpl.jena.ontology.Individual ind,
                               java.lang.String urn)
                        throws NdlException

Add a URN to individual (hasURN)

Parameters:

urn - urn

ind - ind

Throws:

NdlException - in case of error

declareTermBeginning

public com.hp.hpl.jena.ontology.Individual declareTermBeginning(java.util.Date date)
                                                         throws NdlException

Declare beginning of a term

Parameters:

date - date

Returns:

Individual

Throws:

NdlException - in case of error

declareTermEnd

public com.hp.hpl.jena.ontology.Individual declareTermEnd(java.util.Date date)
                                                   throws NdlException

Declare term end

Parameters:

date - date

Returns:

Individual

Throws:

NdlException - in case of error

declareTermDuration

public com.hp.hpl.jena.ontology.Individual declareTermDuration(long dur,
                                                               int units)
                                                        throws NdlException

Declare term duration in units from java.util.Calendar

Parameters:

dur - dur

units - units

Returns:

Individual

Throws:

NdlException - in case of error

declareTermDuration

public com.hp.hpl.jena.ontology.Individual declareTermDuration(long d,
                                                               long hr,
                                                               long min)
                                                        throws NdlException

declare term duration of days, hrs and minutes (can be 0)

Parameters:

d - d

hr - hr

min - min

Returns:

Individual

Throws:

NdlException - in case of error

declareTerm

public com.hp.hpl.jena.ontology.Individual declareTerm()
                                                throws NdlException

Declare a term from now using duration, units comes from java.util.Calandar

Returns:

Individual

Throws:

NdlException - in case of error

addBeginningToTerm

public void addBeginningToTerm(com.hp.hpl.jena.ontology.Individual begI,
                               com.hp.hpl.jena.ontology.Individual termI)
                        throws NdlException

Throws:

NdlException

addEndToTerm

public void addEndToTerm(com.hp.hpl.jena.ontology.Individual endI,
                         com.hp.hpl.jena.ontology.Individual termI)
                  throws NdlException

Throws:

NdlException

addDurationToTerm

public void addDurationToTerm(com.hp.hpl.jena.ontology.Individual durI,
                              com.hp.hpl.jena.ontology.Individual termI)
                       throws NdlException

Throws:

NdlException

declareReservation

public com.hp.hpl.jena.ontology.Individual declareReservation(java.util.Date start,
                                                              java.util.Date end)
                                                       throws NdlException

Declare Reservation individual with start and end date

Parameters:

start - start

end - end

Returns:

Individual

Throws:

NdlException - in case of error

declareReservation

public com.hp.hpl.jena.ontology.Individual declareReservation(java.util.Date start,
                                                              long dur,
                                                              int units)
                                                       throws NdlException

Declare a reservation with a start time and duration

Parameters:

start - start

dur - dur

units - units

Returns:

Individual

Throws:

NdlException - in case of error

declareReservation

public com.hp.hpl.jena.ontology.Individual declareReservation()
                                                       throws NdlException

Declare an empty reservation

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyReservation

public com.hp.hpl.jena.ontology.Individual declareModifyReservation(java.lang.String name)
                                                             throws NdlException

Declare a modify reservation with this name

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementNGIncreaseBy

public com.hp.hpl.jena.ontology.Individual declareModifyElementNGIncreaseBy(com.hp.hpl.jena.ontology.Individual mresI,
                                                                            java.lang.String ngUrl,
                                                                            java.lang.Integer count)
                                                                     throws NdlException

Declare an element of a modify reservation that increases node count in a node group.

Parameters:

mresI - reservation individual

ngUrl - - URL of node group in question

count - - the number to increase node count by

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementNGDeleteNode

public com.hp.hpl.jena.ontology.Individual declareModifyElementNGDeleteNode(com.hp.hpl.jena.ontology.Individual mresI,
                                                                            java.lang.String ngUrl,
                                                                            java.lang.String nodeUrl)
                                                                     throws NdlException

Declare an element of a modify reservation that deletes a node from a node group

Parameters:

mresI - mresI

ngUrl - ngUrl

nodeUrl - nodeUrl

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementRemoveNode

public com.hp.hpl.jena.ontology.Individual declareModifyElementRemoveNode(com.hp.hpl.jena.ontology.Individual mresI,
                                                                          java.lang.String elUrl,
                                                                          java.lang.String guid)
                                                                   throws NdlException

Declare an element of a modify reservation that deletes a single node

Parameters:

mresI - mresI

elUrl - elUrl

guid - guid

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementRemoveLink

public com.hp.hpl.jena.ontology.Individual declareModifyElementRemoveLink(com.hp.hpl.jena.ontology.Individual mresI,
                                                                          java.lang.String elUrl,
                                                                          java.lang.String guid)
                                                                   throws NdlException

Declare an element of a modify reservation that deletes a single link

Parameters:

mresI - mresI

elUrl - elUrl

guid - guid

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementRemoveElement

public com.hp.hpl.jena.ontology.Individual declareModifyElementRemoveElement(com.hp.hpl.jena.ontology.Individual mresI,
                                                                             com.hp.hpl.jena.ontology.Individual el)
                                                                      throws NdlException

Declare an element of a modify reservation that deletes a single element individual

Parameters:

mresI - mresI

el - el

Returns:

Individual

Throws:

NdlException - in case of error

doModifyElement

protected com.hp.hpl.jena.ontology.Individual doModifyElement(com.hp.hpl.jena.ontology.Individual mresI,
                                                              com.hp.hpl.jena.ontology.Individual el,
                                                              java.lang.String modifyAction)
                                                       throws NdlException

Parameters:

mresI - mresI

el - el

modifyAction - modifyAction

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementAddElement

public com.hp.hpl.jena.ontology.Individual declareModifyElementAddElement(com.hp.hpl.jena.ontology.Individual mresI,
                                                                          com.hp.hpl.jena.ontology.Individual el)
                                                                   throws NdlException

Declare an element of a modify reservation that adds a single element (node or link)

Parameters:

mresI - mresI

el - el

Returns:

Individual

Throws:

NdlException - in case of error

declareModifyElementModifyNode

public com.hp.hpl.jena.ontology.Individual declareModifyElementModifyNode(com.hp.hpl.jena.ontology.Individual mresI,
                                                                          com.hp.hpl.jena.ontology.Individual node)
                                                                   throws NdlException

Declare an element to modify an existing node (add interface)

Parameters:

mresI - mresI

node - node

Returns:

Individual

Throws:

NdlException - in case of error

declareSlice

public com.hp.hpl.jena.ontology.Individual declareSlice(java.lang.String sname)
                                                 throws NdlException

Declare a slice with a name

Parameters:

sname - sname

Returns:

Individual

Throws:

NdlException - in case of error

declareOfSlice

public com.hp.hpl.jena.ontology.Individual declareOfSlice(java.lang.String sname)
                                                   throws NdlException

Declare an openflow slice

Parameters:

sname - sname

Returns:

Individual

Throws:

NdlException - in case of error

declareOfController

public com.hp.hpl.jena.ontology.Individual declareOfController(java.lang.String name,
                                                               java.lang.String url)
                                                        throws NdlException

Declare an openflow controller with this URL

Parameters:

name - name

url - url

Returns:

Individual

Throws:

NdlException - in case of error

declareTCPProxy

public com.hp.hpl.jena.ontology.Individual declareTCPProxy(java.lang.String suffix)
                                                    throws NdlException

Declare a TCP proxy

Parameters:

suffix - suffix

Returns:

Individual

Throws:

NdlException - in case of error

addProxyToIndividual

public void addProxyToIndividual(com.hp.hpl.jena.ontology.Individual proxy,
                                 com.hp.hpl.jena.ontology.Individual resI)
                          throws NdlException

Add a proxy to (most likely node)

Parameters:

proxy - proxy

resI - resI

Throws:

NdlException - in case of error

addResourceToReservation

public void addResourceToReservation(com.hp.hpl.jena.ontology.Individual resI,
                                     com.hp.hpl.jena.ontology.Individual toAdd)
                              throws NdlException

add a resource to the reservation

Parameters:

resI - resI

toAdd - toAdd

Throws:

NdlException - in case of error

addSliceToReservation

public void addSliceToReservation(com.hp.hpl.jena.ontology.Individual resI,
                                  com.hp.hpl.jena.ontology.Individual sl)
                           throws NdlException

Add a sub-slice to reservation

Parameters:

resI - resI

sl - sl

Throws:

NdlException - in case of error

addDiskImageToIndividual

public void addDiskImageToIndividual(com.hp.hpl.jena.ontology.Individual diskImage,
                                     com.hp.hpl.jena.ontology.Individual resI)
                              throws NdlException

Add DiskImage to reservation or node

Parameters:

resI - resI

diskImage - diskImage

Throws:

NdlException - in case of error

addDependOnToIndividual

public void addDependOnToIndividual(com.hp.hpl.jena.ontology.Individual dependency,
                                    com.hp.hpl.jena.ontology.Individual ind)
                             throws NdlException

Add dependency to an individual (both should be NetworkElement subclasses)

Parameters:

dependency - dependency

ind - ind

Throws:

NdlException - in case of error

addTermToReservation

public void addTermToReservation(com.hp.hpl.jena.ontology.Individual termI,
                                 com.hp.hpl.jena.ontology.Individual resI)
                          throws NdlException

Add a term to a reservation

Parameters:

resI - resI

termI - Term

Throws:

NdlException - in case of error

getRequestIndividual

public com.hp.hpl.jena.ontology.Individual getRequestIndividual(java.lang.String name)

try to get individual with this name from the request

Parameters:

name - name

Returns:

Individual

getNonrequestIndividual

public com.hp.hpl.jena.ontology.Individual getNonrequestIndividual(java.lang.String name)

get an individual that is not part of request namespace

Parameters:

name - name

Returns:

Individual

declareDomain

public com.hp.hpl.jena.ontology.Individual declareDomain(java.lang.String name)
                                                  throws NdlException

declare a domain site (appends /Domain to name as per convention; declares it in the general http://geni-orca.renci.org/owl prefix, not request prefix)

Parameters:

name - name

Returns:

Individual

Throws:

NdlException - in case of error

addOpenFlowCapable

public void addOpenFlowCapable(com.hp.hpl.jena.ontology.Individual res,
                               java.lang.String version)
                        throws NdlException

Make individual openflow capable (with version 1.0, 1.1 or 1.2)

Parameters:

res - res

version - version

Throws:

NdlException - in case of error

addNodeToDomain

public void addNodeToDomain(com.hp.hpl.jena.ontology.Individual dom,
                            com.hp.hpl.jena.ontology.Individual node)
                     throws NdlException

Bind node to domain

Parameters:

dom - dom

node - node

Throws:

NdlException - in case of error

addDomainToIndividual

public void addDomainToIndividual(com.hp.hpl.jena.ontology.Individual dom,
                                  com.hp.hpl.jena.ontology.Individual ind)
                           throws NdlException

Add 'inDomain' property to individual

Parameters:

dom - dom

ind - ind

Throws:

NdlException - in case of error

addNodeTypeToCE

public void addNodeTypeToCE(java.lang.String ns,
                            java.lang.String tp,
                            com.hp.hpl.jena.ontology.Individual node)
                     throws NdlException

Add node type from particular namespace to node

Parameters:

ns - ns

tp - tp

node - node

Throws:

NdlException - in case of error

removeNodeTypeFromCE

public void removeNodeTypeFromCE(java.lang.String ns,
                                 java.lang.String tp,
                                 com.hp.hpl.jena.ontology.Individual node)
                          throws NdlException

Remove specific node type from node individual

Parameters:

ns - ns

tp - tp

node - node

Throws:

NdlException - in case of error

removeNodeTypeFromCE

public void removeNodeTypeFromCE(com.hp.hpl.jena.ontology.Individual node)
                          throws NdlException

Removes ALL node types from particular node individual

Parameters:

node - node

Throws:

NdlException - in case of error

addPostBootScriptToCE

public void addPostBootScriptToCE(java.lang.String pbscript,
                                  com.hp.hpl.jena.ontology.Individual node)
                           throws NdlException

Add a post boot script string to a node

Parameters:

pbscript - pbscript

node - node

Throws:

NdlException - in case of error

addPortToProxy

public void addPortToProxy(java.lang.String port,
                           com.hp.hpl.jena.ontology.Individual prx)
                    throws NdlException

Add a port to be proxied to a proxy (no information how it will be proxied)

Parameters:

port - port

prx - proxy

Throws:

NdlException - in case of error

addPortToProxy

public void addPortToProxy(java.lang.String port,
                           java.lang.String newPort,
                           java.lang.String newIp,
                           com.hp.hpl.jena.ontology.Individual prx)
                    throws NdlException

Add a port with proxy information about it (new port and new IP address)

Parameters:

port - port

newPort - newport

newIp - newip

prx - prx

Throws:

NdlException - in case of error

addNumCEsToCluster

public void addNumCEsToCluster(java.lang.Integer ns,
                               com.hp.hpl.jena.ontology.Individual cluster)
                        throws NdlException

Add number of compute elements to cluster

Parameters:

ns - ns

cluster - cluster

Throws:

NdlException - in case of error

addVMDomainProperty

public void addVMDomainProperty(com.hp.hpl.jena.ontology.Individual cluster)
                         throws NdlException

Add a VM domain resource property (for Euca clusters)

Parameters:

cluster - cluster

Throws:

NdlException - in case of error

addBareMetalDomainProperty

public void addBareMetalDomainProperty(com.hp.hpl.jena.ontology.Individual cluster)
                                throws NdlException

Throws:

NdlException

addFourtyGBareMetalDomainProperty

public void addFourtyGBareMetalDomainProperty(com.hp.hpl.jena.ontology.Individual cluster)
                                       throws NdlException

Throws:

NdlException

addOfPropertiesToSlice

public void addOfPropertiesToSlice(java.lang.String userEmail,
                                   java.lang.String slicePass,
                                   java.lang.String userCtrl,
                                   com.hp.hpl.jena.ontology.Individual slice)
                            throws NdlException

Add OpenFlow-relevant properties to a slice individual

Parameters:

userEmail - useremail

slicePass - slicepass

userCtrl - userctl

slice - slice

Throws:

NdlException - in case of error

addUserDNProperty

public void addUserDNProperty(java.lang.String dn,
                              com.hp.hpl.jena.ontology.Individual i)
                       throws NdlException

Throws:

NdlException

declareColor

public com.hp.hpl.jena.ontology.Individual declareColor(java.lang.String label,
                                                        java.util.Map<java.lang.String,java.lang.String> keys,
                                                        java.lang.String blob,
                                                        boolean isXML)
                                                 throws NdlException

Declare a new color individual

Parameters:

label - - label

keys - - map of key value pairs

blob - - text blob

isXML - - is it XML?

Returns:

Individual

Throws:

NdlException - in case of error

addKeysOnColor

public void addKeysOnColor(com.hp.hpl.jena.ontology.Individual color,
                           java.util.Map<java.lang.String,java.lang.String> keys)
                    throws NdlException

add keys to color

Parameters:

color - color

keys - keys

Throws:

NdlException - in case of error

addBlobOnColor

public com.hp.hpl.jena.ontology.Individual addBlobOnColor(com.hp.hpl.jena.ontology.Individual color,
                                                          java.lang.String blob,
                                                          boolean isXML)
                                                   throws NdlException

Add text blob to color

Parameters:

color - - color individual

blob - - text blob

isXML - - is it XML?

Returns:

Individual

Throws:

NdlException - in case of error

addBlobOnColor__

public com.hp.hpl.jena.ontology.Individual addBlobOnColor__(com.hp.hpl.jena.ontology.Individual color,
                                                            java.lang.String blob,
                                                            boolean isXML,
                                                            java.lang.String xmlns)
                                                     throws NdlException

Use compression instead of xml literal to get around Jena bugs for XML literals

Parameters:

color - color

blob - blob

isXML - ixXML

xmlns - - namespace for inner xml

Returns:

Individual

Throws:

NdlException - in case of error

encodeColorDependency

public void encodeColorDependency(com.hp.hpl.jena.ontology.Individual from,
                                  com.hp.hpl.jena.ontology.Individual to,
                                  com.hp.hpl.jena.ontology.Individual color)
                           throws NdlException

Encode a color dependency between two network elements

Parameters:

from - - network element

to - - network element

color - - color

Throws:

NdlException - in case of error

addColorToIndividual

public com.hp.hpl.jena.ontology.Individual addColorToIndividual(com.hp.hpl.jena.ontology.Individual ne,
                                                                com.hp.hpl.jena.ontology.Individual color)
                                                         throws NdlException

Throws:

NdlException

addEthernetAdaptation

public com.hp.hpl.jena.ontology.Individual addEthernetAdaptation(com.hp.hpl.jena.ontology.Individual intf,
                                                                 com.hp.hpl.jena.ontology.Individual adaptTo)
                                                          throws NdlException

Add ethernet adaptation to another interface

Parameters:

intf - - interface

adaptTo - - interface to be adapted

Returns:

Individual

Throws:

NdlException - in case of error

addGuid

public void addGuid(com.hp.hpl.jena.ontology.Individual in,
                    java.lang.String guid)
             throws NdlException

Add addGuid property to this individual

Parameters:

in - in

guid - guid

Throws:

NdlException - in case of error

toN3String

public java.lang.String toN3String()

produce N3 output of the model

Returns:

String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXMLString

public java.lang.String toXMLString()

produce RDF-XML output of the model

Returns:

String

getGVOutput

public java.lang.String getGVOutput()

Produce Graphviz output for visualization

Returns:

String

main

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