net.bluemind.directory.api

Interface IDirectory

All Known Implementing Classes:

Directory

@Path(value="/directory/{domain}")
public interface IDirectory

Method Summary

Modifier and Type	Method and Description
ContainerChangelog	changelog(java.lang.Long since) ChangeLog of the container since
ContainerChangeset<java.lang.String>	changeset(java.lang.Long since) ChangeSet of the container since
TaskRef	delete(java.lang.String path) Delete entry
TaskRef	deleteByEntryUid(java.lang.String entryUid) Delete entry
DirEntry	findByEntryUid(java.lang.String entryUid)
DirEntry	getByEmail(java.lang.String email)
java.util.List<DirEntry>	getEntries(java.lang.String path) Fetch DirEntrys from a path
DirEntry	getEntry(java.lang.String path) Fetch DirEntry from a path
byte[]	getEntryIcon(java.lang.String entryUid)
byte[]	getEntryPhoto(java.lang.String entryUid)
byte[]	getIcon(java.lang.String path)
java.util.Set<java.lang.String>	getRolesForDirEntry(java.lang.String entryUid)
java.util.Set<java.lang.String>	getRolesForOrgUnit(java.lang.String orgUnitUid)
DirEntry	getRoot() Fetch root DirEntry
ItemValue<VCard>	getVCard(java.lang.String uid) get entry vcard
ListResult<ItemValue<DirEntry>>	search(DirEntryQuery query)

Method Detail

getRoot

@GET
DirEntry getRoot()
               throws ServerFault

Fetch root DirEntry

Returns:

DirEntry

Throws:

ServerFault

getEntry

@POST
 @Path(value="_entry")
DirEntry getEntry(java.lang.String path)
                                        throws ServerFault

Fetch DirEntry from a path

Parameters:

path - path of entry

Returns:

DirEntry entry

Throws:

ServerFault

getEntries

@POST
 @Path(value="_childs")
java.util.List<DirEntry> getEntries(java.lang.String path)
                                                           throws ServerFault

Fetch DirEntrys from a path

Parameters:

path - path of entries

Returns:

DirEntry child of path

Throws:

ServerFault

delete

@DELETE
 @Path(value="{path}")
TaskRef delete(@PathParam(value="path")
                                              java.lang.String path)
                                       throws ServerFault

Delete entry

Parameters:

path -

Throws:

ServerFault

getVCard

@GET
 @Path(value="{uid}/_vcard")
ItemValue<VCard> getVCard(@PathParam(value="uid")
                                                            java.lang.String uid)
                                                     throws ServerFault

get entry vcard

Parameters:

path -

Throws:

ServerFault

deleteByEntryUid

@DELETE
 @Path(value="_byentryuid/{entryUid}")
TaskRef deleteByEntryUid(@PathParam(value="entryUid")
                                                                        java.lang.String entryUid)
                                                                 throws ServerFault

Delete entry

Parameters:

path -

Throws:

ServerFault

changelog

@GET
 @Path(value="_changelog")
ContainerChangelog changelog(@QueryParam(value="since")
                                                             java.lang.Long since)
                                                      throws ServerFault

ChangeLog of the container since

Parameters:

since - timestamp of first changes we want to retrieve

Returns:

ContainerChangelog

Throws:

ServerFault

changeset

@GET
 @Path(value="_changeset")
ContainerChangeset<java.lang.String> changeset(@QueryParam(value="since")
                                                                               java.lang.Long since)
                                                                        throws ServerFault

ChangeSet of the container since

Parameters:

since - timestamp of first changes we want to retrieve

Throws:

ServerFault

search

@POST
 @Path(value="_search")
ListResult<ItemValue<DirEntry>> search(DirEntryQuery query)
                                                              throws ServerFault

Throws:

ServerFault

findByEntryUid

@GET
 @Path(value="entry-uid/{entryUid}")
DirEntry findByEntryUid(@PathParam(value="entryUid")
                                                                  java.lang.String entryUid)
                                                           throws ServerFault

Throws:

ServerFault

getEntryIcon

@GET
 @Path(value="entry-uid/{entryUid}/icon")
 @Produces(value="image/png")
byte[] getEntryIcon(@PathParam(value="entryUid")
                                                                                                 java.lang.String entryUid)
                                                                                          throws ServerFault

Throws:

ServerFault

getEntryPhoto

@GET
 @Path(value="entry-uid/{entryUid}/photo")
 @Produces(value="image/png")
byte[] getEntryPhoto(@PathParam(value="entryUid")
                                                                                                   java.lang.String entryUid)
                                                                                            throws ServerFault

Throws:

ServerFault

getIcon

@GET
 @Path(value="_icon/{path}")
 @Produces(value="image/png")
byte[] getIcon(@PathParam(value="path")
                                                                               java.lang.String path)
                                                                        throws ServerFault

Throws:

ServerFault

getRolesForDirEntry

@GET
 @Path(value="entry-uid/{entryUid}/rolesfor_")
java.util.Set<java.lang.String> getRolesForDirEntry(@PathParam(value="entryUid")
                                                                                                        java.lang.String entryUid)
                                                                                                 throws ServerFault

Throws:

ServerFault

getRolesForOrgUnit

@GET
 @Path(value="ou-uid/{ouUid}/rolesfor_")
java.util.Set<java.lang.String> getRolesForOrgUnit(@PathParam(value="ouUid")
                                                                                                 java.lang.String orgUnitUid)
                                                                                          throws ServerFault

Throws:

ServerFault

getByEmail

@GET
 @Path(value="_byEmail/{email}")
DirEntry getByEmail(@PathParam(value="email")
                                                          java.lang.String email)