summaryrefslogtreecommitdiff
path: root/openstackclient/object
diff options
context:
space:
mode:
Diffstat (limited to 'openstackclient/object')
-rw-r--r--openstackclient/object/__init__.py12
-rw-r--r--openstackclient/object/client.py58
-rw-r--r--openstackclient/object/v1/__init__.py12
-rw-r--r--openstackclient/object/v1/container.py100
-rw-r--r--openstackclient/object/v1/lib/__init__.py12
-rw-r--r--openstackclient/object/v1/lib/container.py77
-rw-r--r--openstackclient/object/v1/lib/object.py97
-rw-r--r--openstackclient/object/v1/object.py118
8 files changed, 486 insertions, 0 deletions
diff --git a/openstackclient/object/__init__.py b/openstackclient/object/__init__.py
new file mode 100644
index 00000000..02be10cd
--- /dev/null
+++ b/openstackclient/object/__init__.py
@@ -0,0 +1,12 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
diff --git a/openstackclient/object/client.py b/openstackclient/object/client.py
new file mode 100644
index 00000000..a83a5c0a
--- /dev/null
+++ b/openstackclient/object/client.py
@@ -0,0 +1,58 @@
+# Copyright 2013 Nebula Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+"""Object client"""
+
+import logging
+
+from openstackclient.common import utils
+
+LOG = logging.getLogger(__name__)
+
+API_NAME = 'object-store'
+API_VERSIONS = {
+ '1': 'openstackclient.object.client.ObjectClientv1',
+}
+
+
+def make_client(instance):
+ """Returns an object service client."""
+ object_client = utils.get_client_class(
+ API_NAME,
+ instance._api_version[API_NAME],
+ API_VERSIONS)
+ if instance._url:
+ endpoint = instance._url
+ else:
+ endpoint = instance.get_endpoint_for_service_type(API_NAME)
+ LOG.debug('instantiating object client')
+ client = object_client(
+ endpoint=endpoint,
+ token=instance._token,
+ )
+ return client
+
+
+class ObjectClientv1(object):
+
+ def __init__(
+ self,
+ endpoint_type='publicURL',
+ endpoint=None,
+ token=None,
+ ):
+ self.endpoint_type = endpoint_type
+ self.endpoint = endpoint
+ self.token = token
diff --git a/openstackclient/object/v1/__init__.py b/openstackclient/object/v1/__init__.py
new file mode 100644
index 00000000..02be10cd
--- /dev/null
+++ b/openstackclient/object/v1/__init__.py
@@ -0,0 +1,12 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
diff --git a/openstackclient/object/v1/container.py b/openstackclient/object/v1/container.py
new file mode 100644
index 00000000..8c4db66a
--- /dev/null
+++ b/openstackclient/object/v1/container.py
@@ -0,0 +1,100 @@
+# Copyright 2013 Nebula Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+"""Container v1 action implementations"""
+
+
+import logging
+
+from cliff import lister
+
+from openstackclient.common import utils
+from openstackclient.object.v1.lib import container as lib_container
+
+
+class ListContainer(lister.Lister):
+ """List containers"""
+
+ log = logging.getLogger(__name__ + '.ListContainer')
+
+ def get_parser(self, prog_name):
+ parser = super(ListContainer, self).get_parser(prog_name)
+ parser.add_argument(
+ "--prefix",
+ metavar="<prefix>",
+ help="Filter list using <prefix>",
+ )
+ parser.add_argument(
+ "--marker",
+ metavar="<marker>",
+ help="Anchor for paging",
+ )
+ parser.add_argument(
+ "--end-marker",
+ metavar="<end-marker>",
+ help="End anchor for paging",
+ )
+ parser.add_argument(
+ "--limit",
+ metavar="<limit>",
+ type=int,
+ help="Limit the number of containers returned",
+ )
+ parser.add_argument(
+ '--long',
+ action='store_true',
+ default=False,
+ help='List additional fields in output',
+ )
+ parser.add_argument(
+ '--all',
+ action='store_true',
+ default=False,
+ help='List all containers (default is 10000)',
+ )
+ return parser
+
+ def take_action(self, parsed_args):
+ self.log.debug('take_action(%s)' % parsed_args)
+
+ if parsed_args.long:
+ columns = ('Name', 'Bytes', 'Count')
+ else:
+ columns = ('Name',)
+
+ kwargs = {}
+ if parsed_args.prefix:
+ kwargs['prefix'] = parsed_args.prefix
+ if parsed_args.marker:
+ kwargs['marker'] = parsed_args.marker
+ if parsed_args.end_marker:
+ kwargs['end_marker'] = parsed_args.end_marker
+ if parsed_args.limit:
+ kwargs['limit'] = parsed_args.limit
+ if parsed_args.all:
+ kwargs['full_listing'] = True
+
+ data = lib_container.list_containers(
+ self.app.restapi,
+ self.app.client_manager.object.endpoint,
+ **kwargs
+ )
+ #print "data: %s" % data
+
+ return (columns,
+ (utils.get_dict_properties(
+ s, columns,
+ formatters={},
+ ) for s in data))
diff --git a/openstackclient/object/v1/lib/__init__.py b/openstackclient/object/v1/lib/__init__.py
new file mode 100644
index 00000000..02be10cd
--- /dev/null
+++ b/openstackclient/object/v1/lib/__init__.py
@@ -0,0 +1,12 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
diff --git a/openstackclient/object/v1/lib/container.py b/openstackclient/object/v1/lib/container.py
new file mode 100644
index 00000000..f30533c8
--- /dev/null
+++ b/openstackclient/object/v1/lib/container.py
@@ -0,0 +1,77 @@
+# Copyright 2010-2012 OpenStack Foundation
+# Copyright 2013 Nebula Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+"""Object v1 API library"""
+
+
+def list_containers(
+ api,
+ url,
+ marker=None,
+ limit=None,
+ end_marker=None,
+ prefix=None,
+ full_listing=False,
+):
+ """Get containers in an account
+
+ :param api: a restapi object
+ :param url: endpoint
+ :param marker: marker query
+ :param limit: limit query
+ :param end_marker: end_marker query
+ :param prefix: prefix query
+ :param full_listing: if True, return a full listing, else returns a max
+ of 10000 listings
+ :returns: list of containers
+ """
+
+ if full_listing:
+ data = listing = list_containers(
+ api,
+ url,
+ marker,
+ limit,
+ end_marker,
+ prefix,
+ )
+ while listing:
+ marker = listing[-1]['name']
+ listing = list_containers(
+ api,
+ url,
+ marker,
+ limit,
+ end_marker,
+ prefix,
+ )
+ if listing:
+ data.extend(listing)
+ return data
+
+ object_url = url
+ query = "format=json"
+ if marker:
+ query += '&marker=%s' % marker
+ if limit:
+ query += '&limit=%d' % limit
+ if end_marker:
+ query += '&end_marker=%s' % end_marker
+ if prefix:
+ query += '&prefix=%s' % prefix
+ url = "%s?%s" % (object_url, query)
+ response = api.request('GET', url)
+ return response.json()
diff --git a/openstackclient/object/v1/lib/object.py b/openstackclient/object/v1/lib/object.py
new file mode 100644
index 00000000..d7c4a1ce
--- /dev/null
+++ b/openstackclient/object/v1/lib/object.py
@@ -0,0 +1,97 @@
+# Copyright 2010-2012 OpenStack Foundation
+# Copyright 2013 Nebula Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+"""Object v1 API library"""
+
+
+def list_objects(
+ api,
+ url,
+ container,
+ marker=None,
+ limit=None,
+ end_marker=None,
+ delimiter=None,
+ prefix=None,
+ path=None,
+ full_listing=False,
+):
+ """Get objects in a container
+
+ :param api: a restapi object
+ :param url: endpoint
+ :param container: container name to get a listing for
+ :param marker: marker query
+ :param limit: limit query
+ :param end_marker: marker query
+ :param delimiter: string to delimit the queries on
+ :param prefix: prefix query
+ :param path: path query (equivalent: "delimiter=/" and "prefix=path/")
+ :param full_listing: if True, return a full listing, else returns a max
+ of 10000 listings
+ :returns: a tuple of (response headers, a list of objects) The response
+ headers will be a dict and all header names will be lowercase.
+ """
+
+ if full_listing:
+ data = listing = list_objects(
+ api,
+ url,
+ container,
+ marker,
+ limit,
+ end_marker,
+ delimiter,
+ prefix,
+ path,
+ )
+ while listing:
+ if delimiter:
+ marker = listing[-1].get('name', listing[-1].get('subdir'))
+ else:
+ marker = listing[-1]['name']
+ listing = list_objects(
+ api,
+ url,
+ container,
+ marker,
+ limit,
+ end_marker,
+ delimiter,
+ prefix,
+ path,
+ )
+ if listing:
+ data.extend(listing)
+ return data
+
+ object_url = url
+ query = "format=json"
+ if marker:
+ query += '&marker=%s' % marker
+ if limit:
+ query += '&limit=%d' % limit
+ if end_marker:
+ query += '&end_marker=%s' % end_marker
+ if delimiter:
+ query += '&delimiter=%s' % delimiter
+ if prefix:
+ query += '&prefix=%s' % prefix
+ if path:
+ query += '&path=%s' % path
+ url = "%s/%s?%s" % (object_url, container, query)
+ response = api.request('GET', url)
+ return response.json()
diff --git a/openstackclient/object/v1/object.py b/openstackclient/object/v1/object.py
new file mode 100644
index 00000000..c6bd755b
--- /dev/null
+++ b/openstackclient/object/v1/object.py
@@ -0,0 +1,118 @@
+# Copyright 2013 Nebula Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+
+"""Object v1 action implementations"""
+
+
+import logging
+
+from cliff import lister
+
+from openstackclient.common import utils
+from openstackclient.object.v1.lib import object as lib_object
+
+
+class ListObject(lister.Lister):
+ """List objects"""
+
+ log = logging.getLogger(__name__ + '.ListObject')
+
+ def get_parser(self, prog_name):
+ parser = super(ListObject, self).get_parser(prog_name)
+ parser.add_argument(
+ "container",
+ metavar="<container-name>",
+ help="List contents of container-name",
+ )
+ parser.add_argument(
+ "--prefix",
+ metavar="<prefix>",
+ help="Filter list using <prefix>",
+ )
+ parser.add_argument(
+ "--delimiter",
+ metavar="<delimiter>",
+ help="Roll up items with <delimiter>",
+ )
+ parser.add_argument(
+ "--marker",
+ metavar="<marker>",
+ help="Anchor for paging",
+ )
+ parser.add_argument(
+ "--end-marker",
+ metavar="<end-marker>",
+ help="End anchor for paging",
+ )
+ parser.add_argument(
+ "--limit",
+ metavar="<limit>",
+ type=int,
+ help="Limit the number of objects returned",
+ )
+ parser.add_argument(
+ '--long',
+ action='store_true',
+ default=False,
+ help='List additional fields in output',
+ )
+ parser.add_argument(
+ '--all',
+ action='store_true',
+ default=False,
+ help='List all objects in container (default is 10000)',
+ )
+ return parser
+
+ def take_action(self, parsed_args):
+ self.log.debug('take_action(%s)' % parsed_args)
+
+ if parsed_args.long:
+ columns = (
+ 'Name',
+ 'Bytes',
+ 'Hash',
+ 'Content Type',
+ 'Last Modified',
+ )
+ else:
+ columns = ('Name',)
+
+ kwargs = {}
+ if parsed_args.prefix:
+ kwargs['prefix'] = parsed_args.prefix
+ if parsed_args.delimiter:
+ kwargs['delimiter'] = parsed_args.delimiter
+ if parsed_args.marker:
+ kwargs['marker'] = parsed_args.marker
+ if parsed_args.end_marker:
+ kwargs['end_marker'] = parsed_args.end_marker
+ if parsed_args.limit:
+ kwargs['limit'] = parsed_args.limit
+ if parsed_args.all:
+ kwargs['full_listing'] = True
+
+ data = lib_object.list_objects(
+ self.app.restapi,
+ self.app.client_manager.object.endpoint,
+ parsed_args.container,
+ **kwargs
+ )
+
+ return (columns,
+ (utils.get_dict_properties(
+ s, columns,
+ formatters={},
+ ) for s in data))