[Geoserver-users] REST Configuration API

Patel_Ronak_Avinash · April 1, 2009, 8:47pm

From what it looks like, I would have to POST data only in XML?

Or, am I free to post data using JSON?

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Wednesday, April 01, 2009 11:40 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Great, thanks Ronak. When I get some free time I will try to give it an
in depth review. And hopefully hook it up to our test cases to ensure
what geoserver spits out and what it accepts is validated against the
schema. Thanks again!!

Patel, Ronak Avinash (US SSA) wrote:

Justin,

I'm not quite finished, but this is what I have so far:

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 12:00 PM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Documentation is in the works. What you see there is as far as we have

gotten. Another good source of examples (again with curl) is available

in our svn repo:

http://svn.codehaus.org/geoserver/branches/1.7.x/src/extension/restconfi

g/scripts/

Basically it contains some shell scripts that build up the vanilla
geoserver configuration directory from scratch.

Hope that helps.

Patel, Ronak Avinash (US SSA) wrote:

Justin,

I also noticed that while the API provides good docs on how data can

be

retrieved, but is there more examples of how to POST content?

I saw the CURL examples...but I'm wondering about coverages and
layers...which parameters are required? Which ones aren't?

Is there any other documentation I can read regarding that?

Ronak

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 11:51 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Well the connectionParameters will be open ended. So I suggest just
making its content extensible, perhaps making it xs:any or something.

Also there is a bug in the current encoding so it will probably be
changing in subsequent versions. The proposed change is of the form:

<connectionParameters>
<entry key="">value</entry>
<entry key="">value</entry>
</connectionParameters>

This should solve the conflict...

Patel, Ronak Avinash (US SSA) wrote:

Justin,

There's a conflict that I see...the url type is defined twice in two

different ways...such as:

<coverageStore>

  <name>arcGridSample</name>

  <enabled>true</enabled>

  <workspace>

    <name>nurc</name>

    <atom:link xmlns:atom="http://www.w3.org/2005/Atom"

rel="alternate"

href="http://localhost:8080/geoserver/rest/worksapces/nurc.xml"
type="application/xml"/>

  </workspace>

  <type>ArcGrid</type>

* <url>file:coverages/arc_sample/precip30min.asc</url>*

  <coverages>

    <atom:link xmlns:atom="http://www.w3.org/2005/Atom"

rel="alternate"

href="http://localhost:8080/geoserver/rest/workspaces/nurc/coveragestore

s/arcGridSample/coverages.xml"

type="application/xml"/>

  </coverages>

</coverageStore>

And

***<dataStore>*

*** <name>*states_shapefile***</name>*

*** <enabled>*true***</enabled>*

*** <workspace>*

   *** <name>*topp***</name>*

   *** <atom:link* xmlns:atom="http://www.w3.org/2005/Atom"
rel="alternate"
href="http://localhost:8080/geoserver/rest/workspaces/topp.xml"
type="application/xml"***/>*

*** </workspace>*

*** <connectionParameters>*

   *** <namespace>*

     *** <string>*http://www.openplans.org/topp***</string>\*

   *** </namespace>*

   *** <url>*

     *** <string>*file:data/shapefiles/states.shp***</string>*

   *** </url>*

*** </connectionParameters>*

*** <featureTypes>*

   *** <atom:link* xmlns:atom="http://www.w3.org/2005/Atom"
rel="alternate"

href="http://localhost:8080/geoserver/rest/workspaces/topp/datastores/st

ates_shapefile/featuretypes.xml"

type="application/xml"***/>*

*** </featureTypes>*

***</dataStore>*

So it seems that the url element is a complexType and a simpleType??

It

can't be both...

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:44 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Patel, Ronak Avinash (US SSA) wrote:

Another question,
How can I specify which coverages I want to appear in which

layers?

And...do I need to use Styles in order to make layers?

Well first you have to add the coverage. This will implicitly create

a

layer for you which references the coverage under the name

<ws>:<coverageName>

You should be able to create a layer without specifying a default

style,

but one will be assigned to it implicitly.

I don't intend to reverse engineer the whole thing...just the

parts

that

I need so I can get moving.
Ronak
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:14 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
Nope, pretty much spread out across the globe from Vancouver to

Sydney

Patel, Ronak Avinash (US SSA) wrote:

I'm also on PST...I thought you guys were all in Europe...
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:06 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
I will be around for 2-3 more hours, and then online later tonight
(PST).
Patel, Ronak Avinash (US SSA) wrote:

Justin,
Yes, I am doing that now...kinda have to just to fill out values

so I

can POST and GET and make sense of the data.
It's very hard to traverse a DOM when you don't know what the DOM

even

looks like....
I will send it to you for review before I start to use it in my
application.
How long will you be available today?
Thanks!
Ronak
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:01 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
Well... xstream is nice and simple. You do not need to define a

schema

or antyhing to serialize and deserialize objects. We also had a

bunch

of

a xstream based stuff around for serializing the exact same

objects,

so

it made sense to reuse it.
Part of my hesitation of publishing a schema at this point is

that

this

api is very new, and will undoubtedly change. But I realize this

makes

it hard for the client since there is no great way to figure out

what

a

legal representation is.
Anyways, if you do reverse engineer a schema and would be willing

to

share it I would be happy to review it, and incorporate it into

the

api.

-Justin
Patel, Ronak Avinash (US SSA) wrote:

In the meantime, I'll have to improvise and make up the schema

on

my

own

based on the data I see in the examples on your site.
Why did your team decide to use XStream rather than the popular

JAXB

or

XMLBeans Java <-> XML binding APIs?
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 5:43 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
Patel, Ronak Avinash (US SSA) wrote:

Hi,
I am exploring the new REST Configuration API and I was curious

about

the XML datatype.
Do you provide an XSD schema that lists the type of data

structures

that

would be returned from geoserver?

Unfortunately no, not yet. The library we use (XStream) does not

provide

any facility for generating an XML schema, nor should it really.

So

one

thing I was was thinking of was coming up with one manually, but
something i have not got around with.

This would work out well with a JAXB or XMLBeans.

Another thing I would like to do is publish a java based client

api.

Actually there is a summer of code project for this. That way

client

code would really have to worry about what the exact XML

representation

looks like.

Thanks!!
Ronak Patel

------------------------------------------------------------------------

------

_______________________________________________
Geoserver-users mailing list
Geoserver-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-users

--

Justin Deoliveira

OpenGeo - http://opengeo.org

Enterprise support for open source geospatial.

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

Justin_Deoliveira · April 1, 2009, 11:32pm

Yup, you can post XML or JSON. But you seem quite adamant about having a schema for the format... and JSON does not have a formal notation of a schema yet, afaik it is still just a proposal.

Patel, Ronak Avinash (US SSA) wrote:

From what it looks like, I would have to POST data only in XML?

Or, am I free to post data using JSON?

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com] Sent: Wednesday, April 01, 2009 11:40 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Great, thanks Ronak. When I get some free time I will try to give it an in depth review. And hopefully hook it up to our test cases to ensure what geoserver spits out and what it accepts is validated against the schema. Thanks again!!

Patel, Ronak Avinash (US SSA) wrote:

Justin,

I'm not quite finished, but this is what I have so far:

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com] Sent: Tuesday, March 31, 2009 12:00 PM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Documentation is in the works. What you see there is as far as we have

gotten. Another good source of examples (again with curl) is available

in our svn repo:

http://svn.codehaus.org/geoserver/branches/1.7.x/src/extension/restconfi

g/scripts/

Basically it contains some shell scripts that build up the vanilla geoserver configuration directory from scratch.

Hope that helps.

Patel, Ronak Avinash (US SSA) wrote:

Justin,

I also noticed that while the API provides good docs on how data can

be

retrieved, but is there more examples of how to POST content?

I saw the CURL examples...but I'm wondering about coverages and
layers...which parameters are required? Which ones aren't?

Is there any other documentation I can read regarding that?

Ronak

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com] Sent: Tuesday, March 31, 2009 11:51 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Well the connectionParameters will be open ended. So I suggest just making its content extensible, perhaps making it xs:any or something.

Also there is a bug in the current encoding so it will probably be changing in subsequent versions. The proposed change is of the form:

<connectionParameters>
   <entry key="">value</entry>
</connectionParameters>

This should solve the conflict...

Patel, Ronak Avinash (US SSA) wrote:

Justin,

There's a conflict that I see...the url type is defined twice in two

different ways...such as:

<coverageStore>

  <name>arcGridSample</name>

  <enabled>true</enabled>

  <workspace>

    <name>nurc</name>

    <atom:link xmlns:atom="http://www.w3.org/2005/Atom"

rel="alternate"

href="http://localhost:8080/geoserver/rest/worksapces/nurc.xml" type="application/xml"/>

  </workspace>

  <type>ArcGrid</type>

* <url>file:coverages/arc_sample/precip30min.asc</url>*

  <coverages>

    <atom:link xmlns:atom="http://www.w3.org/2005/Atom"

rel="alternate"

href="http://localhost:8080/geoserver/rest/workspaces/nurc/coveragestore

s/arcGridSample/coverages.xml"

type="application/xml"/>

  </coverages>

</coverageStore>

And

***<dataStore>*

*** <name>*states_shapefile***</name>*

*** <enabled>*true***</enabled>*

*** <workspace>*

   *** <name>*topp***</name>*

   *** <atom:link* xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/topp.xml" type="application/xml"***/>*

*** </workspace>*

*** <connectionParameters>*

   *** <namespace>*

     *** <string>*http://www.openplans.org/topp***</string>\*

   *** </namespace>*

   *** <url>*

     *** <string>*file:data/shapefiles/states.shp***</string>*

   *** </url>*

*** </connectionParameters>*

*** <featureTypes>*

   *** <atom:link* xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate"

href="http://localhost:8080/geoserver/rest/workspaces/topp/datastores/st

ates_shapefile/featuretypes.xml"

type="application/xml"***/>*

*** </featureTypes>*

***</dataStore>*

So it seems that the url element is a complexType and a simpleType??

It

can't be both...

-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:44 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API

Patel, Ronak Avinash (US SSA) wrote:

Another question,
How can I specify which coverages I want to appear in which

layers?

And...do I need to use Styles in order to make layers?

Well first you have to add the coverage. This will implicitly create

a

layer for you which references the coverage under the name

<ws>:<coverageName>

You should be able to create a layer without specifying a default

style,

but one will be assigned to it implicitly.

I don't intend to reverse engineer the whole thing...just the

parts

that

I need so I can get moving.
Ronak
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:14 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
Nope, pretty much spread out across the globe from Vancouver to

Sydney

Patel, Ronak Avinash (US SSA) wrote:

I'm also on PST...I thought you guys were all in Europe...
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:06 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
I will be around for 2-3 more hours, and then online later tonight
(PST).
Patel, Ronak Avinash (US SSA) wrote:

Justin,
Yes, I am doing that now...kinda have to just to fill out values

so I

can POST and GET and make sense of the data.
It's very hard to traverse a DOM when you don't know what the DOM

even

looks like....
I will send it to you for review before I start to use it in my
application.
How long will you be available today?
Thanks!
Ronak
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 10:01 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
Well... xstream is nice and simple. You do not need to define a

schema

or antyhing to serialize and deserialize objects. We also had a

bunch

of

a xstream based stuff around for serializing the exact same

objects,

so

it made sense to reuse it.
Part of my hesitation of publishing a schema at this point is

that

this

api is very new, and will undoubtedly change. But I realize this

makes

it hard for the client since there is no great way to figure out

what

a

legal representation is.
Anyways, if you do reverse engineer a schema and would be willing

to

share it I would be happy to review it, and incorporate it into

the

api.

-Justin
Patel, Ronak Avinash (US SSA) wrote:

In the meantime, I'll have to improvise and make up the schema

on

my

own

based on the data I see in the examples on your site.
Why did your team decide to use XStream rather than the popular

JAXB

or

XMLBeans Java <-> XML binding APIs?
-----Original Message-----
From: Justin Deoliveira [mailto:jdeolive@anonymised.com]
Sent: Tuesday, March 31, 2009 5:43 AM
To: Patel, Ronak Avinash (US SSA)
Cc: geoserver-users@lists.sourceforge.net
Subject: Re: [Geoserver-users] REST Configuration API
Patel, Ronak Avinash (US SSA) wrote:

Hi,
I am exploring the new REST Configuration API and I was curious

about

the XML datatype.
Do you provide an XSD schema that lists the type of data

structures

that

would be returned from geoserver?

Unfortunately no, not yet. The library we use (XStream) does not

provide

any facility for generating an XML schema, nor should it really.

So

one

thing I was was thinking of was coming up with one manually, but
something i have not got around with.

This would work out well with a JAXB or XMLBeans.

Another thing I would like to do is publish a java based client

api.

Actually there is a summer of code project for this. That way

client

code would really have to worry about what the exact XML

representation

looks like.

Thanks!!
Ronak Patel

------------------------------------------------------------------------

------

_______________________________________________
Geoserver-users mailing list
Geoserver-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-users

--

Justin Deoliveira

OpenGeo - http://opengeo.org

Enterprise support for open source geospatial.

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.