doc/server_api_versions.txt
author Shawn Walker <shawn.walker@oracle.com>
Sat, 16 Jul 2011 08:45:13 -0700
changeset 2468 ce77b64883c4
parent 1970 60471574c487
permissions -rw-r--r--
18710 conditional dependencies can cause install and uninstall failure when dependency cannot be installed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1970
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     1
Version 10:
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     2
    Incompatible with clients using versions 0-9.
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     3
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     4
    pkg.server.api changed as follows:
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     5
        * The PackageInfo.PREF_PUBLISHER property and data was removed.
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     6
    
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     7
        * The CatalogInterface.INFO_MULTI_MATCH property was removed and
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     8
          the info() method no longer detects and considers multiple
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
     9
          matches for a single pattern an error.
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
    10
1968
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    11
Version 9:
1970
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
    12
    Incompatible with clients using versions 0-8.
1968
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    13
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    14
    pkg.server.api changed as follows:
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    15
        * All feed related properties retrieved or set using the
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    16
          (get|set)_repo_* methods are no longer valid.  Instead,
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    17
          all feed-related configuration information must be
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    18
          retrieved using the new depot configuration methods
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    19
          found in the ConfigInterface class.
c0540b1e4f7e 8722 advanced repository metadata store needed
Shawn Walker <shawn.walker@oracle.com>
parents: 1850
diff changeset
    20
1850
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    21
Version 8:
1970
60471574c487 16238 client api should ignore invalid and not yet supported packages
Shawn Walker <shawn.walker@oracle.com>
parents: 1968
diff changeset
    22
    Incompatible with clients using versions 0-7.
1850
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    23
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    24
    pkg.server.api changed as follows:
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    25
        * The return type of CatalogInterface.search changed so that instead
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    26
          of returning the fmri string in the result, it returns a PkgFmri
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    27
          object.
0ddf4a6601cd 15482 Fix for bug 6177 breaks bui search
Brock Pytlik <bpytlik@sun.com>
parents: 1638
diff changeset
    28
1638
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    29
Version 7:
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    30
    Compatible with clients using version 6.
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    31
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    32
    CatalogInterface has changed as follows:
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    33
        * A new function named 'info' was added to provide a way to
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    34
          retrieved package information.  It returns a PackageInfo
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    35
          object representing the set of available package information.
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    36
          See pydoc 'pkg.client.api.PackageInfo' for more information.
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    37
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    38
        * A new function named 'get_entry_all_variants' was added to
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    39
          provide access to the list of variants for a given package.
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    40
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    41
    pkg.server.api changed as follows:
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    42
        * New classes representing package metadata and license
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    43
          information were added to pkg.api_common.
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    44
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    45
    pkg.server.api_errors changed as follows:
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    46
        * A new exception named 'UnrecognizedOptionsToInfo' was added.
43c8e6c924a3 12852 pkg.server.api should have methods for getting package information
Rajkumar Srinivasan <rajkumar.srinivasan@sun.com>
parents: 1431
diff changeset
    47
1431
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    48
Version 6:
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    49
Incompatible with clients using versions 0-5.
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    50
    CatalogInterface:
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    51
        * get_matching_pattern_fmris() and get_matching_version_fmris()
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    52
          now return a tuple of (fmris, unmatched).  Where 'fmris' is
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    53
          a list of matching FMRIs, and 'unmatched' is a dict of
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    54
          unmatched patterns or versions indexed by match criteria.
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    55
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    56
        * package_count now returns the number of unique packages in the
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    57
          catalog instead of the unique number of package versions.
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    58
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    59
        * package_version_count, a new property, was added that contains
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    60
          the number of unique package versions in the catalog.
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    61
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    62
     ConfigInterface:
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    63
        * get_repo_attrs was renamed to get_repo_properties
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    64
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    65
        * get_repo_attr_value was renamed to get_repo_property_value
62b6033670e4 10416 server catalog v1 support desired
Shawn Walker <srw@sun.com>
parents: 1117
diff changeset
    66
1117
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    67
Version 5:
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    68
Compatible with clients using Versions 3-4.
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    69
    ConfigInterface.get_repo_attr_value() has changed as follows:
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    70
        * Section 'feed' attribute 'authority' has been removed.  It has been
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    71
          replaced by section 'publisher' attribute 'prefix'.
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    72
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    73
        * Section 'publisher' with attributes 'alias' and 'prefix' was added.
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    74
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    75
        * New attributes were added for section 'repository': 'collection_type',
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    76
          'legal_uris', 'mirrors', 'origins', 'refresh_seconds',
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    77
          'registration_uri', and 'related_uris'.  See the pydoc for
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    78
          pkg.server.api.ConfigInterface for details.
667aecade0ab 7862 install links using p5i for search results desired
Shawn Walker <srw@sun.com>
parents: 1116
diff changeset
    79
1116
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    80
Version 4:
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    81
Compatible with clients using Version 3.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    82
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    83
Changes:
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    84
    CatalogInterface.search() has changed as follows:
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    85
        * A docstring has been added; see pydoc pkg.server.api for details.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    86
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    87
        * Added optional keyword 'matching_version' that allows consumers to
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    88
          filter search results based on version.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    89
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    90
        * Added optional, boolean keyword 'return_latest' that causes only the
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    91
          the newest versions of packages to be returned when 'return_type'
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    92
          is Query.RETURN_PACKAGES.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    93
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    94
Version 3:
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    95
Incompatible with clients using Versions 0-2.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    96
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    97
Changes:
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    98
    CatalogInterface.search() has changed as follows:
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
    99
        * Added optional, boolean keyword 'case_sensitive'.  This indicates
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   100
          whether a case-sensitive search should be performed.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   101
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   102
        * Added optional keyword argument 'return_type'.  This determines
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   103
          whether results should be returned as Query.RETURN_ACTIONS or
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   104
          Query.RETURN_PACKAGES.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   105
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   106
        * Added optional, integer keyword argument 'start_point'.  This
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   107
          specifies how many matching results should be skipped before
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   108
          returning anything.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   109
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   110
        * Added optional, integer keyword argument 'num_to_return'.  This
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   111
          indicates how many results should be returned before the search
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   112
          is aborted.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   113
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   114
        * search_done() was removed.  Previously, after calling search(), api
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   115
          consumers would have to call search_done().  This is no longer
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   116
          necessary.
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   117
852
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   118
Version 2:
1116
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   119
Incompatible with clients using Versions 0-1.
852
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   120
Changes:
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   121
CatalogInterface.get_matching_version_fmris() no longer accepts the constraint
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   122
parameter.  However, as before, it expects a list of version strings for the
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   123
'versions' parameter.  These version strings may now contain the wildcard
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   124
characters '*' and '?'.
96c4a4dace99 5999 catalog.extract_matching_fmris - version filtering not correct
Shawn Walker <Shawn.Walker@Sun.COM>
parents: 759
diff changeset
   125
759
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   126
Version 1:
1116
5eb1d9f5bd88 2741 advanced web-based package search capability desired
Shawn Walker <srw@sun.com>
parents: 852
diff changeset
   127
Incompatible with clients using Version 0.
759
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   128
Changes:
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   129
CatalogInterface.search_done() was added to perform cleanup after all results
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   130
have been retrieved from search().
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   131
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   132
CatalogInterface.search() now returns a generator object, instead of a list
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   133
object, that requires that CatalogInterface.search_done() is called after all
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   134
of the desired results have been retrieved for proper cleanup.
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   135
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   136
Version 0:
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   137
Initial api version, containing the following:
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   138
class BaseInterface
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   139
        -- used to instantiate other interface objects
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   140
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   141
class CatalogInterface
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   142
        def __init__(self, version_id, base):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   143
        def fmris(self):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   144
        def get_matching_pattern_fmris(self, patterns):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   145
        def get_matching_version_fmris(self, versions,
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   146
            constraint=pkg.version.CONSTRAINT_AUTO):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   147
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   148
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   149
        last_modified
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   150
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   151
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   152
        package_count
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   153
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   154
        def search(self, token):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   155
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   156
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   157
        search_available
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   158
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   159
class ConfigInterface
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   160
        def __init__(self, version_id, base):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   161
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   162
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   163
        catalog_requests
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   164
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   165
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   166
        content_root
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   167
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   168
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   169
        file_requests
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   170
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   171
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   172
        filelist_requests
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   173
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   174
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   175
        filelist_file_requests
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   176
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   177
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   178
        in_flight_transactions
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   179
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   180
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   181
        manifest_requests
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   182
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   183
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   184
        mirror
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   185
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   186
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   187
        readonly
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   188
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   189
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   190
        rename_requests
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   191
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   192
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   193
        web_root
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   194
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   195
        def get_repo_attrs(self):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   196
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   197
        def get_repo_attr_value(self, section, attr):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   198
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   199
class RequestInterface
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   200
        def __init__(self, version_id, base):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   201
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   202
        def get_accepted_languages(self):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   203
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   204
        def get_rel_path(self, uri):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   205
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   206
        def log(self, msg):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   207
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   208
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   209
        params
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   210
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   211
        @property
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   212
        path_info
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   213
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   214
        def url(self, path='', qs='', script_name=None, relative=None):
38cd83f208a8 5629 depot web search needs to limit result set size
Shawn Walker <Shawn.Walker@Sun.COM>
parents:
diff changeset
   215