AssetServer/ClientDocs - Revision history

MakoBot: Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name

2012-03-04T06:13:14Z

Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name

MakoBot: Robot: Cosmetic changes

2012-03-04T04:43:14Z

Robot: Cosmetic changes

MakoBot: Robot: Cosmetic changes

2012-03-04T01:58:22Z

Robot: Cosmetic changes

Show changes

Makopoppo at 09:10, 4 June 2011

2011-06-04T09:10:10Z

Mark.malewski: /* See Also */ Updated "See Also" heading with links.

2009-05-21T20:17:10Z

‎See Also: Updated "See Also" heading with links.

Mark.malewski: /* See Also */ Updated "See Also" heading with additional linked pages.

2009-05-21T19:42:05Z

‎See Also: Updated "See Also" heading with additional linked pages.

Mark.malewski: Added "turtle track" navigation to the top of the page, also added category tags

2009-05-21T11:59:21Z

Added "turtle track" navigation to the top of the page, also added category tags

Mark.malewski: /* See Also */ updated hyperlinks to point to correct pages

2009-05-21T11:36:54Z

‎See Also: updated hyperlinks to point to correct pages

Ideia Boa at 10:34, 21 May 2009

2009-05-21T10:34:59Z

Mark.malewski: AssetServerProposal/ClientDocs moved to AssetServer/ClientDocs: I understand this is a work in progress, but I am moving this document to the "AssetServer" working folder. Please continue to update and finalize this document, and remove the "prop

2009-05-21T10:17:39Z

AssetServerProposal/ClientDocs moved to AssetServer/ClientDocs: I understand this is a work in progress, but I am moving this document to the "AssetServer" working folder. Please continue to update and finalize this document, and remove the "prop

@@ Line 6: / Line 6: @@
 = Client Documentation =
-Through the variety of extensions that ship with the asset server, several wire protocol formats are supported. Connectors for existing OpenSim grid protocols have been added wherever possible, along with new frontends that support web browsers and extensible metadata through JSON.
+Through the variety of extensions that ship with the asset server, several wire protocol formats are supported. Connectors for existing OpenSimulator grid protocols have been added wherever possible, along with new frontends that support web browsers and extensible metadata through JSON.
 == Reference Asset Protocol ==
-In the previous OpenSim asset model, asset requests and asset data proxied through simulators to a backend asset service. This required sending asset data over UDP and adding unnecessary bandwidth overhead to simulators.
+In the previous OpenSimulator asset model, asset requests and asset data proxied through simulators to a backend asset service. This required sending asset data over UDP and adding unnecessary bandwidth overhead to simulators.
 [[File:Client-sim-assetserver-original.png]]
-Previous OpenSim asset flow diagram
+Previous OpenSimulator asset flow diagram
 [[File:Client-sim-assetserver-distributed.png]]
@@ Line 104: / Line 104: @@
 The asset server treats all stored content as binary blobs with content types. Some content types can have special handlers that expose additional methods or metadata, such as image/jp2 returning extended metadata for the number of image components and byte offsets of the quality layers. However, no special handling is needed for storing and serving up data. To store ShockWave Flash files, use the content-type application/x-shockwave-flash and upload a .swf file.
-To maintain compatibility with existing virtual worlds, MIME types have been defined for the existing OpenSim asset types. It is important that the correct content-type is used for uploads. The following table shows the mapping between OpenSim assets, commonly used file extensions, and content-types. Note that some of the formats used already have recognized MIME types. Anything starting with application/x-metaverse is ad hoc.
+To maintain compatibility with existing virtual worlds, MIME types have been defined for the existing OpenSimulator asset types. It is important that the correct content-type is used for uploads. The following table shows the mapping between OpenSimulator assets, commonly used file extensions, and content-types. Note that some of the formats used already have recognized MIME types. Anything starting with application/x-metaverse is ad hoc.
 {|
-! OpenSim Type
+! OpenSimulator Type
 ! File Extensions
 ! Content-Type
@@ Line 116: / Line 116: @@
 | 1 || ogg,sound || application/ogg || OGG Vorbis audio
 |-
-| 2 || callingcard || application/x-metaverse-callingcard || OpenSim calling card. Custom/undocumented text format
+| 2 || callingcard || application/x-metaverse-callingcard || OpenSimulator calling card. Custom/undocumented text format
 |-
-| 3 || landmark || application/x-metaverse-landmark || OpenSim landmark. Custom/undocumented text format
+| 3 || landmark || application/x-metaverse-landmark || OpenSimulator landmark. Custom/undocumented text format
 |-
-| 5 || clothing || application/x-metaverse-clothing || OpenSim clothing. Custom/undocumented text format
+| 5 || clothing || application/x-metaverse-clothing || OpenSimulator clothing. Custom/undocumented text format
 |-
-| 6 || primitive || application/x-metaverse-primitive || OpenSim primitive. Custom/undocumented XML format
+| 6 || primitive || application/x-metaverse-primitive || OpenSimulator primitive. Custom/undocumented XML format
 |-
-| 7 || notecard || application/x-metaverse-notecard || OpenSim notecard. Custom/undocumented text format
+| 7 || notecard || application/x-metaverse-notecard || OpenSimulator notecard. Custom/undocumented text format
 |-
-| 10 || lsl || application/x-metaverse-lsl || OpenSim LSL script
+| 10 || lsl || application/x-metaverse-lsl || OpenSimulator LSL script
 |-
-| 11 || lso || application/x-metaverse-lso || OpenSim compiled script binary. Currently unused
+| 11 || lso || application/x-metaverse-lso || OpenSimulator compiled script binary. Currently unused
 |-
 | 12 || tga || image/tga || Targa image. Currently unused
 |-
-| 13 || bodypart || application/x-metaverse-bodypart || OpenSim bodypart. Custom/undocumented text format
+| 13 || bodypart || application/x-metaverse-bodypart || OpenSimulator bodypart. Custom/undocumented text format
 |-
 | 17 || wav || audio/x-wav || WAV audio file
@@ Line 138: / Line 138: @@
 | 19 || jpg,jpeg || image/jpeg || JPEG texture
 |-
-| 20 || animation || application/x-metaverse-animation || OpenSim animation. Custom/undocumented binary format
+| 20 || animation || application/x-metaverse-animation || OpenSimulator animation. Custom/undocumented binary format
 |-
-| 21 || gesture || application/x-metaverse-gesture || OpenSim gesture. Custom/undocumented format
+| 21 || gesture || application/x-metaverse-gesture || OpenSimulator gesture. Custom/undocumented format
 |-
-| 22 || simstate || application/x-metaverse-simstate || OpenSim simulator state. Currently unused
+| 22 || simstate || application/x-metaverse-simstate || OpenSimulator simulator state. Currently unused
 |-
 | -1 || (none,unknown) || application/octet-stream || Arbitrary or unrecognized binary data
@@ Line 151: / Line 151: @@
 The inventory reference protocol is a work in progress. Leave notes on the discussion page for this document or start a thread on the [https://lists.berlios.de/mailman/listinfo/opensim-dev opensim-dev] mailing list if you'd like to be a part of the process.
-== OpenSim Asset Protocol ==
+== OpenSimulator Asset Protocol ==
-The OpenSim.Grid.AssetServer.exe protocol uses a REST interface for retrieving and storing assets. Assets are fetched with a GET to /assets/[assetid] or /assets/[assetid]?texture. The additional ?texture parameter is optional and does not change the response in any way. Asset data and metadata are returned in an XML format, with the asset data base64 encoded as an XML element. To upload, the same XML data structure that is received from a GET is POSTed to /assets/. The XML data is serialized from a class in OpenSim code, therefore the structure is subject to change. The current XML serialization is undocumented outside of source code.
+The OpenSim.Grid.AssetServer.exe protocol uses a REST interface for retrieving and storing assets. Assets are fetched with a GET to /assets/[assetid] or /assets/[assetid]?texture. The additional ?texture parameter is optional and does not change the response in any way. Asset data and metadata are returned in an XML format, with the asset data base64 encoded as an XML element. To upload, the same XML data structure that is received from a GET is POSTed to /assets/. The XML data is serialized from a class in OpenSimulator code, therefore the structure is subject to change. The current XML serialization is undocumented outside of source code.
-== OpenSim Inventory Protocol ==
+== OpenSimulator Inventory Protocol ==
 OpenSim.Grid.InventoryServer.exe supports both a REST-like interface and an XML-RPC interface. Although the former interface shares some similar properties with a REST interface, it defines an additional messaging layer using HTTP POSTs of XML data for all requests. The REST-like interface is actually somewhere between SOAP and XML-RPC.
@@ Line 175: / Line 175: @@
 == Authentication ==
-If an asset is protected, an identity must be proven by a client (and that identity authorized to access the asset) before access is granted. Internally the asset server stores identities as URLs. A number of different methods of proving client identity can be used depending on the setup of the asset server. The reference asset server has OpenID login support at http://[yourserver.com]/authenticate. This is a simple OpenID login process that can happen over the reference JSON protocol, or through web forms. If the OpenID provider being used is setup with a well formed login method (such as the current OpenSim user server), the entire process can happen without user intervention. Once the OpenID authentication has completed, a UUID token will be returned to the client. Optionally, a cookie will be returned as well containing the same token. This token is a temporary proof of identity that can be used in the Authorization header when requesting assets.
+If an asset is protected, an identity must be proven by a client (and that identity authorized to access the asset) before access is granted. Internally the asset server stores identities as URLs. A number of different methods of proving client identity can be used depending on the setup of the asset server. The reference asset server has OpenID login support at http://[yourserver.com]/authenticate. This is a simple OpenID login process that can happen over the reference JSON protocol, or through web forms. If the OpenID provider being used is setup with a well formed login method (such as the current OpenSimulator user server), the entire process can happen without user intervention. Once the OpenID authentication has completed, a UUID token will be returned to the client. Optionally, a cookie will be returned as well containing the same token. This token is a temporary proof of identity that can be used in the Authorization header when requesting assets.
 Instead of directly logging into the asset server, a common grid setup may be that the login server contacts an asset server that it knows about to inform it of a successful login and create a temporary session token. This token could be passed back to the client to avoid having to login to both the login server and asset server. Another setup may involve the client using an SSL client certificate signed by an authority that the asset server trusts. The different methods of authenticating allow flexibility between creating a loose, decentralized set of grids and services and a tightly coupled closed or semi-closed grid.

@@ Line 12: / Line 12: @@
 In the previous OpenSim asset model, asset requests and asset data proxied through simulators to a backend asset service. This required sending asset data over UDP and adding unnecessary bandwidth overhead to simulators.
-[[Image:Client-sim-assetserver-original.png]]
+[[File:Client-sim-assetserver-original.png]]
 Previous OpenSim asset flow diagram
-[[Image:Client-sim-assetserver-distributed.png]]
+[[File:Client-sim-assetserver-distributed.png]]
 Distributed Asset Service flow diagram

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Template:Quicklinks}}
+{{Quicklinks}}
-−
-[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[AssetServer | AssetServer]] -> [[AssetServer/ClientDocs | AssetServer Client Documentation]]
 {{proposal}}
 {{content}}

@@ Line 183: / Line 183: @@
 = See Also =
-* [[AssetServer|Asset Server]]
+* [[:Category:Getting Started|Getting Started]]
-* [[AssetServer/ClientDocs|AssetServer Client Documentation]]
+* [[OpenSim:Introduction_and_Definitions|What are UGAIM Services?]]
-* [[AssetServer/DeveloperDocs|AssetServer Developer Documentation]]
+* [[UserServer|User Server ]]
 * [[GridServer|Grid Server ]]
 * [[GridServer/ClientDocs|GridServer Client Documentation]]
 * [[GridServer/DeveloperDocs|GridServer Developer Documentation]]
 * [[:Category:Tech Reference|Technical Reference Pages]]
 [[Category:Support]]

@@ Line 184: / Line 184: @@
 * [[AssetServer|Asset Server]]
-* [[AssetServer/DeveloperDocs|Developer Documentation]]
+* [[AssetServer/ClientDocs|AssetServer Client Documentation]]
+* [[AssetServer/DeveloperDocs|AssetServer Developer Documentation]]
 [[Category:Support]]

← Older revision		Revision as of 10:34, 21 May 2009
Line 1:		Line 1:
		+	__NOTOC__
		+	{{Template:Quicklinks}}
		+
	=Client Documentation=		=Client Documentation=