net.bluemind.addressbook.api

Interface IAddressBooksMgmt

All Known Implementing Classes:

AddressBooksMgmt

@Path(value="/mgmt/addressbooks")
public interface IAddressBooksMgmt

Addressbooks management api

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IAddressBooksMgmt.ChangesetItem

Method Summary

Modifier and Type	Method and Description
Stream	backup(java.lang.String abUid, java.lang.Long since)
void	create(java.lang.String uid, AddressBookDescriptor descriptor, boolean isDefault)
void	delete(java.lang.String abUid)
AddressBookDescriptor	getComplete(java.lang.String uid)
TaskRef	reindex(java.lang.String bookUid) reindex an addressbook
TaskRef	reindexAll()
TaskRef	reindexDomain(java.lang.String domainUid)
void	restore(java.lang.String abUid, Stream restoreStream, boolean resetBeforeRestore)
void	update(java.lang.String uid, AddressBookDescriptor descriptor)

Method Detail

reindexAll

@POST
 @Path(value="_reindex")
TaskRef reindexAll()
                                           throws ServerFault

Throws:

ServerFault

reindexDomain

@POST
 @Path(value="_reindexDomain")
TaskRef reindexDomain(@QueryParam(value="domain")
                                                           java.lang.String domainUid)
                                                    throws ServerFault

Throws:

ServerFault

reindex

@POST
 @Path(value="{containerUid}/_reindex")
TaskRef reindex(@PathParam(value="containerUid")
                                                              java.lang.String bookUid)
                                                       throws ServerFault

reindex an addressbook

Parameters:

bookUid -

Returns:

Throws:

ServerFault

backup

@GET
 @Path(value="{containerUid}/_backupstream")
Stream backup(@PathParam(value="containerUid")
                                                                java.lang.String abUid,
                                                                @QueryParam(value="since")
                                                                java.lang.Long since)
                                                         throws ServerFault

Throws:

ServerFault

restore

@POST
 @Path(value="{containerUid}/_restorestream")
void restore(@PathParam(value="containerUid")
                                                                 java.lang.String abUid,
                                                                 Stream restoreStream,
                                                                 @QueryParam(value="reset")
                                                                 boolean resetBeforeRestore)
                                                          throws ServerFault

Throws:

ServerFault

delete

@DELETE
 @Path(value="{containerUid}")
void delete(@PathParam(value="containerUid")
                                                   java.lang.String abUid)
                                            throws ServerFault

Throws:

ServerFault

getComplete

@Path(value="{containerUid}")
 @GET
AddressBookDescriptor getComplete(@PathParam(value="containerUid")
                                                                      java.lang.String uid)
                                                               throws ServerFault

Throws:

ServerFault

create

@Path(value="{containerUid}")
 @PUT
void create(@PathParam(value="containerUid")
                                                java.lang.String uid,
                                                AddressBookDescriptor descriptor,
                                                @QueryParam(value="isDefault")
                                                boolean isDefault)
                                         throws ServerFault

Throws:

ServerFault

update

@Path(value="{containerUid}")
 @POST
void update(@PathParam(value="containerUid")
                                                 java.lang.String uid,
                                                 AddressBookDescriptor descriptor)
                                          throws ServerFault

Throws:

ServerFault