ServiceProvider (b3p-commons-gis 9.3 API)

java.lang.Object
- nl.b3p.wms.capabilities.ServiceProvider

All Implemented Interfaces:: ServiceProviderInterface, XMLElement

public class ServiceProvider
extends Object
implements XMLElement, ServiceProviderInterface

Constructor Summary

Constructors
Constructor and Description

ServiceProvider()
default ServiceProvider() constructor.

Constructors
Constructor and Description
`ServiceProvider()` default ServiceProvider() constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDomainResource(ServiceDomainResource dr)`
`void`	`addException(String except)`
`void`	`addKeyword(String keyword)`
`void`	`addRole(Roles role)`
`void`	`addTileSet(TileSet ts)`
`void`	`convertValues2KB(HashMap conversionValues)` Method that will overwrite the URL's stored in the database with the URL specified for Kaartenbalie.
`String`	`getAbbr()`
`String`	`getAbstracts()`
`String`	`getAccessConstraints()`
`Set`	`getAllLayers()`
`Boolean`	`getAllowed()`
`Set`	`getAllRoles()`
`ContactInformation`	`getContactInformation()`
`nl.b3p.commons.services.B3PCredentials`	`getCredentials()` Returns the service login credentials
`Set`	`getDomainResource()`
`Set`	`getExceptions()`
`Date`	`getExpireDate()`
`String`	`getFees()`
`String`	`getGivenName()`
`Integer`	`getId()`
`Boolean`	`getIgnoreResource()`
`String`	`getName()`
`String`	`getOrganizationCode()`
`String`	`getPassword()`
`String`	`getPersonalCode()`
`ServiceDomainResource`	`getServiceDomainResourceByOperationName(String operationName)` Returns the ServiceDomainResource with the given operationname and null if not exists
`Set`	`getServiceProviderKeywordList()`
`String`	`getSldUrl()`
`String`	`getStatus()`
`TileSet`	`getTileSet(Layer layer)` Returned de tileset van (alleen) deze layer.
`Set<TileSet>`	`getTileSets()`
`String`	`getTitle()`
`Layer`	`getTopLayer()`
`String`	`getType()`
`Date`	`getUpdatedDate()`
`String`	`getUrl()`
`String`	`getUrlServiceProvideCode()`
`String`	`getUserName()`
`String`	`getWmsVersion()`
`boolean`	`isIsSynchronized()`
`void`	`setAbbr(String abbr)`
`void`	`setAbstracts(String abstracts)`
`void`	`setAccessConstraints(String accessConstraints)`
`void`	`setAllowed(Boolean allowed)`
`void`	`setAllRoles(Set allRoles)`
`void`	`setContactInformation(ContactInformation contactInformation)`
`void`	`setDomainResource(Set domainResource)`
`void`	`setExceptions(Set exceptions)`
`void`	`setExpireDate(Date expireDate)`
`void`	`setFees(String fees)`
`void`	`setGivenName(String givenName)`
`protected void`	`setId(Integer id)`
`void`	`setIgnoreResource(Boolean ignoreResource)`
`void`	`setIsSynchronized(boolean isSynchronized)`
`void`	`setLayers(Set layers)`
`void`	`setName(String name)`
`void`	`setOrganizationCode(String code)`
`void`	`setPassword(String password)`
`void`	`setPersonalCode(String personalCode)`
`void`	`setServiceProviderKeywordList(Set serviceProviderKeywordList)`
`void`	`setSldUrl(String sldUrl)`
`void`	`setStatus(String status)`
`void`	`setTileSets(Set<TileSet> tileSets)`
`void`	`setTitle(String title)`
`void`	`setTopLayer(Layer topLayer)`
`void`	`setUpdatedDate(Date updatedDate)`
`void`	`setUrl(String url)`
`void`	`setUrlServiceProvideCode(String urlServiceProvideCode)`
`void`	`setUserName(String userName)`
`void`	`setWmsVersion(String wmsVersion)`
`ServiceProvider`	`shallowClone()`
`Element`	`toElement(Document doc, Element rootElement)` Method that will create piece of the XML tree to create a proper XML docuement.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ServiceProvider
```
public ServiceProvider()
```
  default ServiceProvider() constructor.

Method Detail

getId
```
public Integer getId()
```
Specified by:

getId in interface ServiceProviderInterface

setId
```
protected void setId(Integer id)
```

getName
```
public String getName()
```
Specified by:

getName in interface ServiceProviderInterface

setName
```
public void setName(String name)
```

getTitle
```
public String getTitle()
```
Specified by:

getTitle in interface ServiceProviderInterface

setTitle
```
public void setTitle(String title)
```

getAbstracts
```
public String getAbstracts()
```

setAbstracts

public void setAbstracts(String abstracts)

getFees
```
public String getFees()
```

setFees
```
public void setFees(String fees)
```

getAccessConstraints
```
public String getAccessConstraints()
```

setAccessConstraints

public void setAccessConstraints(String accessConstraints)

getGivenName
```
public String getGivenName()
```
Specified by:

getGivenName in interface ServiceProviderInterface

setGivenName

public void setGivenName(String givenName)

getUrl
```
public String getUrl()
```
Specified by:

getUrl in interface ServiceProviderInterface

setUrl
```
public void setUrl(String url)
```

getUpdatedDate
```
public Date getUpdatedDate()
```
Specified by:

getUpdatedDate in interface ServiceProviderInterface

setUpdatedDate

public void setUpdatedDate(Date updatedDate)

getContactInformation

public ContactInformation getContactInformation()

setContactInformation

public void setContactInformation(ContactInformation contactInformation)

getExceptions
```
public Set getExceptions()
```

setExceptions

public void setExceptions(Set exceptions)

addException

public void addException(String except)

getDomainResource
```
public Set getDomainResource()
```

setDomainResource

public void setDomainResource(Set domainResource)

addDomainResource

public void addDomainResource(ServiceDomainResource dr)

setAllRoles

public void setAllRoles(Set allRoles)

getAllRoles
```
public Set getAllRoles()
```

addRole
```
public void addRole(Roles role)
```

getOrganizationCode
```
public String getOrganizationCode()
```

setOrganizationCode

public void setOrganizationCode(String code)

getAllLayers
```
public Set getAllLayers()
```

getTopLayer

public Layer getTopLayer()
                  throws Exception

Throws:: Exception

setTopLayer

public void setTopLayer(Layer topLayer)

getServiceProviderKeywordList

public Set getServiceProviderKeywordList()

setServiceProviderKeywordList

public void setServiceProviderKeywordList(Set serviceProviderKeywordList)

addKeyword

public void addKeyword(String keyword)

convertValues2KB
```
public void convertValues2KB(HashMap conversionValues)
                      throws Exception
```
Method that will overwrite the URL's stored in the database with the URL specified for Kaartenbalie. This new URL indicate the link to the kaartenbalie, while the old link is used to indicate the URL to the real location of the service. Because the client which is connected to kaartenbalie has to send his requests back to kaartenbalie and not directly to the official resource, the URL has to be replaced.

Parameters:

newUrl - String representing the URL the old URL has to be replaced with.

Throws:

Exception

toElement
```
public Element toElement(Document doc,
                         Element rootElement)
```
Method that will create piece of the XML tree to create a proper XML docuement.

Specified by:

toElement in interface XMLElement

Parameters:

doc - Document object which is being used to create new Elements

rootElement - The element where this object belongs to.

Returns:

an object of type Element

getWmsVersion
```
public String getWmsVersion()
```

setWmsVersion

public void setWmsVersion(String wmsVersion)

setLayers
```
public void setLayers(Set layers)
```

isIsSynchronized
```
public boolean isIsSynchronized()
```

setIsSynchronized

public void setIsSynchronized(boolean isSynchronized)

getAbbr
```
public String getAbbr()
```
Specified by:

getAbbr in interface ServiceProviderInterface

setAbbr
```
public void setAbbr(String abbr)
```

getExpireDate
```
public Date getExpireDate()
```

setExpireDate

public void setExpireDate(Date expireDate)

getPersonalCode
```
public String getPersonalCode()
```

setPersonalCode

public void setPersonalCode(String personalCode)

getUserName
```
public String getUserName()
```

setUserName

public void setUserName(String userName)

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String status)
```

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getSldUrl
```
public String getSldUrl()
```

setSldUrl
```
public void setSldUrl(String sldUrl)
```

shallowClone
```
public ServiceProvider shallowClone()
```

getServiceDomainResourceByOperationName
```
public ServiceDomainResource getServiceDomainResourceByOperationName(String operationName)
```
Returns the ServiceDomainResource with the given operationname and null if not exists

getType
```
public String getType()
```
Specified by:

getType in interface ServiceProviderInterface

getTileSets
```
public Set<TileSet> getTileSets()
```

setTileSets

public void setTileSets(Set<TileSet> tileSets)

addTileSet
```
public void addTileSet(TileSet ts)
```

getTileSet
```
public TileSet getTileSet(Layer layer)
```
Returned de tileset van (alleen) deze layer. Als er meerder layers in een tileset zitten wordt deze tileset niet gereturned.

getIgnoreResource
```
public Boolean getIgnoreResource()
```

setIgnoreResource

public void setIgnoreResource(Boolean ignoreResource)

getCredentials
```
public nl.b3p.commons.services.B3PCredentials getCredentials()
```
Returns the service login credentials

Returns:

The credentials

setAllowed

public void setAllowed(Boolean allowed)

getAllowed
```
public Boolean getAllowed()
```

getUrlServiceProvideCode
```
public String getUrlServiceProvideCode()
```
Returns:

the urlServiceProvideCode

setUrlServiceProvideCode
```
public void setUrlServiceProvideCode(String urlServiceProvideCode)
```
Parameters:

urlServiceProvideCode - the urlServiceProvideCode to set

Class ServiceProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceProvider

Method Detail

getId

setId

getName

setName

getTitle

setTitle

getAbstracts

setAbstracts

getFees

setFees

getAccessConstraints

setAccessConstraints

getGivenName

setGivenName

getUrl

setUrl

getUpdatedDate

setUpdatedDate

getContactInformation

setContactInformation

getExceptions

setExceptions

addException

getDomainResource

setDomainResource

addDomainResource

setAllRoles

getAllRoles

addRole

getOrganizationCode

setOrganizationCode

getAllLayers

getTopLayer

setTopLayer

getServiceProviderKeywordList

setServiceProviderKeywordList

addKeyword

convertValues2KB

toElement

getWmsVersion

setWmsVersion

setLayers

isIsSynchronized

setIsSynchronized

getAbbr

setAbbr

getExpireDate

setExpireDate

getPersonalCode

setPersonalCode

getUserName

setUserName

getStatus

setStatus

getPassword

setPassword

getSldUrl

setSldUrl

shallowClone

getServiceDomainResourceByOperationName

getType

getTileSets

setTileSets

addTileSet

getTileSet

getIgnoreResource

setIgnoreResource

getCredentials

setAllowed

getAllowed

getUrlServiceProvideCode

setUrlServiceProvideCode